Package CIM14 :: Package IEC61968 :: Package Metering :: Module Pending' :: Class Pending

Class Pending

      object --+    
               |    
Element'.Element --+
                   |
                  Pending

When present, a scalar conversion that is associated with IntervalBlock and which needs to be applied to every contained IntervalReading value. This conversion results in a new associated ReadingType, reflecting the true dimensions of interval reading values after the conversion.

Instance Methods

[hide private]

__init__(self, scalarDenominator=0, scalarFloat=0.0, scalarNumerator=0, multiplyBeforeAdd=False, offset=0, IntervalBlocks=None, ReadingType=None, *args, **kw_args)
Initialises a new 'Pending' instance.

addIntervalBlocks(self, *IntervalBlocks)

getIntervalBlocks(self)
All blocks of interval reading values to which this pending conversion applies.

getReadingType(self)
Reading type resulting from this pending conversion.

removeIntervalBlocks(self, *IntervalBlocks)

setIntervalBlocks(self, value)

setReadingType(self, value)

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Class Variables

[hide private]

_attr_types = {'multiplyBeforeAdd': <type 'bool'>, 'offset': <...

_attrs = ['scalarDenominator', 'scalarFloat', 'scalarNumerator...

_defaults = {'multiplyBeforeAdd': False, 'offset': 0, 'scalarD...

_many_refs = ['IntervalBlocks']

_refs = ['IntervalBlocks', 'ReadingType']

Inherited from Element'.Element (private): _enums

Properties

[hide private]

IntervalBlocks
All blocks of interval reading values to which this pending conversion applies.

ReadingType
Reading type resulting from this pending conversion.

Inherited from object: __class__

Method Details

[hide private]

init(self, scalarDenominator=0, scalarFloat=0.0, scalarNumerator=0, multiplyBeforeAdd=False, offset=0, IntervalBlocks=None, ReadingType=None, *args, **kw_args)
(Constructor)

Initialises a new 'Pending' instance.

Parameters:

scalarDenominator - (if scalar is rational number) When 'IntervalReading.value' is multiplied by this attribute and divided by 'scalarDenominator, it causes a unit of measure conversion to occur, resulting in the 'ReadingType.unit'.
scalarFloat - (if scalar is floating number) When multiplied with 'IntervalReading.value', it causes a unit of measure conversion to occur, resulting in the 'ReadingType.unit'.
scalarNumerator - (if scalar is integer or rational number) When the scalar is a simple integer, and this attribute is presented alone and multiplied with 'IntervalReading.value', it causes a unit of measure conversion to occur, resulting in the 'ReadingType.unit'. It is never used in conjunction with 'scalarFloat', only with 'scalarDenominator'.
multiplyBeforeAdd - Whether scalars should be applied before adding the 'offset'.
offset - (if applicable) Offset to be added as well as multiplication using scalars.
IntervalBlocks - All blocks of interval reading values to which this pending conversion applies.
ReadingType - Reading type resulting from this pending conversion.

Overrides: object.__init__

Class Variable Details

[hide private]

_attr_types

Value:

{'multiplyBeforeAdd': <type 'bool'>,
 'offset': <type 'int'>,
 'scalarDenominator': <type 'int'>,
 'scalarFloat': <type 'float'>,
 'scalarNumerator': <type 'int'>}

_attrs

Value:

['scalarDenominator',
 'scalarFloat',
 'scalarNumerator',
 'multiplyBeforeAdd',
 'offset']

_defaults

Value:

{'multiplyBeforeAdd': False,
 'offset': 0,
 'scalarDenominator': 0,
 'scalarFloat': 0.0,
 'scalarNumerator': 0}

Property Details

[hide private]

IntervalBlocks

All blocks of interval reading values to which this pending conversion applies.

Get Method:: getIntervalBlocks(self) - All blocks of interval reading values to which this pending conversion applies.
Set Method:: setIntervalBlocks(self, value)

ReadingType

Reading type resulting from this pending conversion.

Get Method:: getReadingType(self) - Reading type resulting from this pending conversion.
Set Method:: setReadingType(self, value)

Class Pending

__init__(self, scalarDenominator=0, scalarFloat=0.0, scalarNumerator=0, multiplyBeforeAdd=False, offset=0, IntervalBlocks=None, ReadingType=None, *args, **kw_args) (Constructor)

_attr_types

_attrs

_defaults

IntervalBlocks

ReadingType

init(self, scalarDenominator=0, scalarFloat=0.0, scalarNumerator=0, multiplyBeforeAdd=False, offset=0, IntervalBlocks=None, ReadingType=None, *args, **kw_args)
(Constructor)