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

Class DeviceFunction

                                  object --+            
                                           |            
                            Element'.Element --+        
                                               |        
IEC61970.Core.IdentifiedObject'.IdentifiedObject --+    
                                                   |    
                 Assets.AssetFunction'.AssetFunction --+
                                                       |
                                                      DeviceFunction
Known Subclasses:

Function performed by a device such as a meter, communication equipment, controllers, etc.

Instance Methods [hide private]
 
__init__(self, disabled=False, EndDeviceAsset=None, Registers=None, EndDeviceEvents=None, *args, **kw_args)
Initialises a new 'DeviceFunction' instance.
 
addEndDeviceEvents(self, *EndDeviceEvents)
 
addRegisters(self, *Registers)
 
getEndDeviceAsset(self)
End device asset that performs this function.
 
getEndDeviceEvents(self)
All events reported by this device function.
 
getRegisters(self)
All registers for quantities metered by this device function.
 
removeEndDeviceEvents(self, *EndDeviceEvents)
 
removeRegisters(self, *Registers)
 
setEndDeviceAsset(self, value)
 
setEndDeviceEvents(self, value)
 
setRegisters(self, value)

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 = {'disabled': <type 'bool'>}
  _attrs = ['disabled']
  _defaults = {'disabled': False}
  _many_refs = ['Registers', 'EndDeviceEvents']
  _refs = ['EndDeviceAsset', 'Registers', 'EndDeviceEvents']

Inherited from Element'.Element (private): _enums

Properties [hide private]
  EndDeviceAsset
End device asset that performs this function.
  EndDeviceEvents
All events reported by this device function.
  Registers
All registers for quantities metered by this device function.

Inherited from Assets.AssetFunction'.AssetFunction: Asset

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

Inherited from object: __class__

Method Details [hide private]

__init__(self, disabled=False, EndDeviceAsset=None, Registers=None, EndDeviceEvents=None, *args, **kw_args)
(Constructor)

 

Initialises a new 'DeviceFunction' instance.

Parameters:
  • disabled - True if the device function is disabled (deactivated). Default is false (i.e., function is enabled).
  • EndDeviceAsset - End device asset that performs this function.
  • Registers - All registers for quantities metered by this device function.
  • EndDeviceEvents - All events reported by this device function.
Overrides: object.__init__

Property Details [hide private]

EndDeviceAsset

End device asset that performs this function.

Get Method:
getEndDeviceAsset(self) - End device asset that performs this function.
Set Method:
setEndDeviceAsset(self, value)

EndDeviceEvents

All events reported by this device function.

Get Method:
getEndDeviceEvents(self) - All events reported by this device function.
Set Method:
setEndDeviceEvents(self, value)

Registers

All registers for quantities metered by this device function.

Get Method:
getRegisters(self) - All registers for quantities metered by this device function.
Set Method:
setRegisters(self, value)