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

Class EndDeviceControl

                                  object --+        
                                           |        
                            Element'.Element --+    
                                               |    
IEC61970.Core.IdentifiedObject'.IdentifiedObject --+
                                                   |
                                                  EndDeviceControl

Instructs an end device (or an end device group) to perform a specified action.Instructs an end device (or an end device group) to perform a specified action.

Instance Methods

[hide private]

__init__(self, drProgramLevel=0, drProgramMandatory=False, type='', priceSignal=0.0, DemandResponseProgram=None, CustomerAgreement=None, scheduledInterval=None, EndDeviceGroup=None, EndDevice=None, *args, **kw_args)
Initialises a new 'EndDeviceControl' instance.

getCustomerAgreement(self)
Could be deprecated in the future.

getDemandResponseProgram(self)
Demand response program for this end device control.

getEndDevice(self)
End device receiving commands from this end device control.

getEndDeviceGroup(self)
End device group receiving commands from this end device control.

setCustomerAgreement(self, value)

setDemandResponseProgram(self, value)

setEndDevice(self, value)

setEndDeviceGroup(self, value)

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 = {'drProgramLevel': <type 'int'>, 'drProgramManda...

_attrs = ['drProgramLevel', 'drProgramMandatory', 'type', 'pri...

_defaults = {'drProgramLevel': 0, 'drProgramMandatory': False,...

_many_refs = []

_refs = ['DemandResponseProgram', 'CustomerAgreement', 'schedu...

scheduledInterval = None

Inherited from Element'.Element (private): _enums

Properties

[hide private]

CustomerAgreement
Could be deprecated in the future.

DemandResponseProgram
Demand response program for this end device control.

EndDevice
End device receiving commands from this end device control.

EndDeviceGroup
End device group receiving commands from this end device control.

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

Inherited from object: __class__

Method Details

[hide private]

init(self, drProgramLevel=0, drProgramMandatory=False, type=`''`, priceSignal=0.0, DemandResponseProgram=None, CustomerAgreement=None, scheduledInterval=None, EndDeviceGroup=None, EndDevice=None, *args, **kw_args)
(Constructor)

Initialises a new 'EndDeviceControl' instance.

Parameters:

drProgramLevel - Level of a demand response program request, where 0=emergency. Note: Attribute is not defined on DemandResponseProgram as it is not its inherent property (it serves to control it).
drProgramMandatory - Whether a demand response program request is mandatory. Note: Attribute is not defined on DemandResponseProgram as it is not its inherent property (it serves to control it).
type - Type of control.
priceSignal - (if applicable) Price signal used as parameter for this end device control.
DemandResponseProgram - Demand response program for this end device control.
CustomerAgreement - Could be deprecated in the future.
scheduledInterval - (if control has scheduled duration) Date and time interval the control has been scheduled to execute within.
EndDeviceGroup - End device group receiving commands from this end device control.
EndDevice - End device receiving commands from this end device control.

Overrides: object.__init__

Class Variable Details

[hide private]

_attr_types

Value:

{'drProgramLevel': <type 'int'>,
 'drProgramMandatory': <type 'bool'>,
 'priceSignal': <type 'float'>,
 'type': <type 'str'>}

_attrs

Value:

['drProgramLevel', 'drProgramMandatory', 'type', 'priceSignal']

_defaults

Value:

{'drProgramLevel': 0,
 'drProgramMandatory': False,
 'priceSignal': 0.0,
 'type': ''}

_refs

Value:

['DemandResponseProgram',
 'CustomerAgreement',
 'scheduledInterval',
 'EndDeviceGroup',
 'EndDevice']

Property Details

[hide private]

CustomerAgreement

Could be deprecated in the future.

Get Method:: getCustomerAgreement(self) - Could be deprecated in the future.
Set Method:: setCustomerAgreement(self, value)

DemandResponseProgram

Demand response program for this end device control.

Get Method:: getDemandResponseProgram(self) - Demand response program for this end device control.
Set Method:: setDemandResponseProgram(self, value)

EndDevice

End device receiving commands from this end device control.

Get Method:: getEndDevice(self) - End device receiving commands from this end device control.
Set Method:: setEndDevice(self, value)

EndDeviceGroup

End device group receiving commands from this end device control.

Get Method:: getEndDeviceGroup(self) - End device group receiving commands from this end device control.
Set Method:: setEndDeviceGroup(self, value)

Class EndDeviceControl

__init__(self, drProgramLevel=0, drProgramMandatory=False, type='', priceSignal=0.0, DemandResponseProgram=None, CustomerAgreement=None, scheduledInterval=None, EndDeviceGroup=None, EndDevice=None, *args, **kw_args) (Constructor)

_attr_types

_attrs

_defaults

_refs

CustomerAgreement

DemandResponseProgram

EndDevice

EndDeviceGroup

init(self, drProgramLevel=0, drProgramMandatory=False, type=`''`, priceSignal=0.0, DemandResponseProgram=None, CustomerAgreement=None, scheduledInterval=None, EndDeviceGroup=None, EndDevice=None, *args, **kw_args)
(Constructor)