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

Class ComFunction

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

Communication function of communication equipment or a device such as a meter.

Instance Methods [hide private]
 
__init__(self, amrRouter='', twoWay=False, amrAddress='', *args, **kw_args)
Initialises a new 'ComFunction' 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 = {'amrAddress': <type 'str'>, 'amrRouter': <type ...
  _attrs = ['amrRouter', 'twoWay', 'amrAddress']
  _defaults = {'amrAddress': '', 'amrRouter': '', 'twoWay': False}
  _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, amrRouter='', twoWay=False, amrAddress='', *args, **kw_args)
(Constructor)

 

Initialises a new 'ComFunction' instance.

Parameters:
  • amrRouter - Communication ID number (e.g. port number, serial number, data collector ID, etc.) of the parent device associated to this AMR module. Note: If someone swaps out a meter, they may inadvertently disrupt the AMR system. Some technologies route readings from nearby meters through a common collection point on an electricity meter. Removal of such a meter disrupts AMR for numerous nearby meters.
  • twoWay - True when the AMR module can both send and receive messages. Default is false (i.e., module can only send).
  • amrAddress - Communication ID number (e.g. serial number, IP address, telephone number, etc.) of the AMR module which serves this meter.
Overrides: object.__init__

Class Variable Details [hide private]

_attr_types

Value:
{'amrAddress': <type 'str'>,
 'amrRouter': <type 'str'>,
 'twoWay': <type 'bool'>}