Package CIM14 :: Package IEC61968 :: Package Metering :: Module ElectricMeteringFunction' :: Class ElectricMeteringFunction
[hide private]
[frames] | no frames]

Class ElectricMeteringFunction

                                  object --+                
                                           |                
                            Element'.Element --+            
                                               |            
IEC61970.Core.IdentifiedObject'.IdentifiedObject --+        
                                                   |        
                 Assets.AssetFunction'.AssetFunction --+    
                                                       |    
                          DeviceFunction'.DeviceFunction --+
                                                           |
                                                          ElectricMeteringFunction

Functionality performed by an electric meter.

Instance Methods [hide private]
 
__init__(self, billingMultiplierApplied=False, kWMultiplier=0, demandMultiplier=0.0, demandMultiplierApplied=False, transformerRatiosApplied=False, voltageRating=0.0, billingMultiplier=0.0, transformerVTRatio=0.0, kWhMultiplier=0, transformerCTRatio=0.0, currentRating=0.0, *args, **kw_args)
Initialises a new 'ElectricMeteringFunction' instance.

Inherited from DeviceFunction'.DeviceFunction: addEndDeviceEvents, addRegisters, getEndDeviceAsset, getEndDeviceEvents, getRegisters, removeEndDeviceEvents, removeRegisters, setEndDeviceAsset, setEndDeviceEvents, setRegisters

Inherited from Assets.AssetFunction'.AssetFunction: getAsset, setAsset

Inherited from IEC61970.Core.IdentifiedObject'.IdentifiedObject: getModelingAuthoritySet, setModelingAuthoritySet

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

Class Variables [hide private]
  _attr_types = {'billingMultiplier': <type 'float'>, 'billingMu...
  _attrs = ['billingMultiplierApplied', 'kWMultiplier', 'demandM...
  _defaults = {'billingMultiplier': 0.0, 'billingMultiplierAppli...
  _many_refs = []
  _refs = []

Inherited from Element'.Element (private): _enums

Properties [hide private]

Inherited from DeviceFunction'.DeviceFunction: EndDeviceAsset, EndDeviceEvents, Registers

Inherited from Assets.AssetFunction'.AssetFunction: Asset

Inherited from IEC61970.Core.IdentifiedObject'.IdentifiedObject: ModelingAuthoritySet

Inherited from object: __class__

Method Details [hide private]

__init__(self, billingMultiplierApplied=False, kWMultiplier=0, demandMultiplier=0.0, demandMultiplierApplied=False, transformerRatiosApplied=False, voltageRating=0.0, billingMultiplier=0.0, transformerVTRatio=0.0, kWhMultiplier=0, transformerCTRatio=0.0, currentRating=0.0, *args, **kw_args)
(Constructor)

 

Initialises a new 'ElectricMeteringFunction' instance.

Parameters:
  • billingMultiplierApplied - True if the billingMultiplier ratio has already been applied to the associated quantities.
  • kWMultiplier - Meter kW (pulse) multiplier, used as a multiplier for a meter register reading to determine the actual amount of usage for which to bill a customer.
  • demandMultiplier - An additional multiplier that may be used for normalization of the demand value to an hourly value. For example, if the demand interval were set to 15 min, the demand multiplier would be 4. If the meter design is such that the demand value reported and displayed is compensated for by the meter itself and no additional scaling is required outside of the meter, the value of the demand multiplier should be '1'.
  • demandMultiplierApplied - True if the demandMultiplier ratio has already been applied to the associated quantities.
  • transformerRatiosApplied - True if transformer ratios have been already applied to the associated quantities.
  • voltageRating - The service voltage at which the meter is designed to operate. Typical voltage ratings in North America are 120 V, 240 V, 277 V or 480 V.
  • billingMultiplier - Customer billing value = meter multiplier * transformer ratios * reading value. The multiplier identifies the scaling value to apply to the reported value after delivery of the tagged item.
  • transformerVTRatio - Voltage transformer ratio used to convert associated quantities to real measurements.
  • kWhMultiplier - Meter kWh multiplier, used as a multiplier for a meter register reading to determine the actual amount of usage for which to bill a customer.
  • transformerCTRatio - Current transformer ratio used to convert associated quantities to real measurements.
  • currentRating - The current class of the meter. Typical current classes in North America are 10 A, 20 A, 100 A, 200 A, or 320 A.
Overrides: object.__init__

Class Variable Details [hide private]

_attr_types

Value:
{'billingMultiplier': <type 'float'>,
 'billingMultiplierApplied': <type 'bool'>,
 'currentRating': <type 'float'>,
 'demandMultiplier': <type 'float'>,
 'demandMultiplierApplied': <type 'bool'>,
 'kWMultiplier': <type 'int'>,
 'kWhMultiplier': <type 'int'>,
 'transformerCTRatio': <type 'float'>,
...

_attrs

Value:
['billingMultiplierApplied',
 'kWMultiplier',
 'demandMultiplier',
 'demandMultiplierApplied',
 'transformerRatiosApplied',
 'voltageRating',
 'billingMultiplier',
 'transformerVTRatio',
...

_defaults

Value:
{'billingMultiplier': 0.0,
 'billingMultiplierApplied': False,
 'currentRating': 0.0,
 'demandMultiplier': 0.0,
 'demandMultiplierApplied': False,
 'kWMultiplier': 0,
 'kWhMultiplier': 0,
 'transformerCTRatio': 0.0,
...