Package CIM15 :: Package IEC61968 :: Package Metering :: Module EndDeviceFunction' :: Class EndDeviceFunction

Class EndDeviceFunction

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

Known Subclasses:

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

Instance Methods

[hide private]

__init__(self, enabled=False, supported=False, Registers=None, ComEquipment=None, EndDeviceEvents=None, EndDevice=None, *args, **kw_args)
Initialises a new 'EndDeviceFunction' instance.

addEndDeviceEvents(self, *EndDeviceEvents)

addRegisters(self, *Registers)

getComEquipment(self)
Communication equipment performing this device function.

getEndDevice(self)
End device that performs this function.

getEndDeviceEvents(self)
All events reported by this end device function.

getRegisters(self)
All registers for quantities metered by this end device function.

removeEndDeviceEvents(self, *EndDeviceEvents)

removeRegisters(self, *Registers)

setComEquipment(self, value)

setEndDevice(self, value)

setEndDeviceEvents(self, value)

setRegisters(self, value)

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

Inherited from IEC61970.Core.IdentifiedObject'.IdentifiedObject: addDiagramObjects, addNames, getDiagramObjects, getModelingAuthoritySet, getNames, removeDiagramObjects, removeNames, setDiagramObjects, setModelingAuthoritySet, setNames

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

Class Variables

[hide private]

_attr_types = {'enabled': <type 'bool'>, 'supported': <type 'b...

_attrs = ['enabled', 'supported']

_defaults = {'enabled': False, 'supported': False}

_many_refs = ['Registers', 'EndDeviceEvents']

_refs = ['Registers', 'ComEquipment', 'EndDeviceEvents', 'EndD...

Inherited from Element'.Element (private): _enums

Properties

[hide private]

ComEquipment
Communication equipment performing this device function.

EndDevice
End device that performs this function.

EndDeviceEvents
All events reported by this end device function.

Registers
All registers for quantities metered by this end device function.

Inherited from Assets.AssetFunction'.AssetFunction: Asset

Inherited from IEC61970.Core.IdentifiedObject'.IdentifiedObject: DiagramObjects, ModelingAuthoritySet, Names

Inherited from object: __class__

Method Details

[hide private]

init(self, enabled=False, supported=False, Registers=None, ComEquipment=None, EndDeviceEvents=None, EndDevice=None, *args, **kw_args)
(Constructor)

Initialises a new 'EndDeviceFunction' instance.

Parameters:

enabled - True if the function is enabled (current operating status; makes sense only if 'supported'=true).
supported - True if the function is supported (inherent property of the device).
Registers - All registers for quantities metered by this end device function.
ComEquipment - Communication equipment performing this device function.
EndDeviceEvents - All events reported by this end device function.
EndDevice - End device that performs this function.

Overrides: object.__init__

Class Variable Details

[hide private]

_attr_types

Value:

{'enabled': <type 'bool'>, 'supported': <type 'bool'>}

_refs

Value:

['Registers', 'ComEquipment', 'EndDeviceEvents', 'EndDevice']

Property Details

[hide private]

ComEquipment

Communication equipment performing this device function.

Get Method:: getComEquipment(self) - Communication equipment performing this device function.
Set Method:: setComEquipment(self, value)

EndDevice

End device that performs this function.

Get Method:: getEndDevice(self) - End device that performs this function.
Set Method:: setEndDevice(self, value)

EndDeviceEvents

All events reported by this end device function.

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

Registers

All registers for quantities metered by this end device function.

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

Class EndDeviceFunction

__init__(self, enabled=False, supported=False, Registers=None, ComEquipment=None, EndDeviceEvents=None, EndDevice=None, *args, **kw_args) (Constructor)

_attr_types

_refs

ComEquipment

EndDevice

EndDeviceEvents

Registers

init(self, enabled=False, supported=False, Registers=None, ComEquipment=None, EndDeviceEvents=None, EndDevice=None, *args, **kw_args)
(Constructor)