Package CIM14 :: Package IEC61968 :: Package Metering :: Module DemandResponseProgram' :: Class DemandResponseProgram

Class DemandResponseProgram

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

Demand response program.

Instance Methods

[hide private]

__init__(self, type='', CustomerAgreements=None, EndDeviceControls=None, validityInterval=None, EndDeviceGroups=None, *args, **kw_args)
Initialises a new 'DemandResponseProgram' instance.

addCustomerAgreements(self, *CustomerAgreements)

addEndDeviceControls(self, *EndDeviceControls)

addEndDeviceGroups(self, *EndDeviceGroups)

getCustomerAgreements(self)
All customer agreements with this demand response program.

getEndDeviceControls(self)
All end device controls with this demand response program.

getEndDeviceGroups(self)
All groups of end devices with this demand response program.

removeCustomerAgreements(self, *CustomerAgreements)

removeEndDeviceControls(self, *EndDeviceControls)

removeEndDeviceGroups(self, *EndDeviceGroups)

setCustomerAgreements(self, value)

setEndDeviceControls(self, value)

setEndDeviceGroups(self, value)

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 = {'type': <type 'str'>}

_attrs = ['type']

_defaults = {'type': ''}

_many_refs = ['CustomerAgreements', 'EndDeviceControls', 'EndD...

_refs = ['CustomerAgreements', 'EndDeviceControls', 'validityI...

validityInterval = None

Inherited from Element'.Element (private): _enums

Properties

[hide private]

CustomerAgreements
All customer agreements with this demand response program.

EndDeviceControls
All end device controls with this demand response program.

EndDeviceGroups
All groups of end devices with this demand response program.

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

Inherited from object: __class__

Method Details

[hide private]

init(self, type=`''`, CustomerAgreements=None, EndDeviceControls=None, validityInterval=None, EndDeviceGroups=None, *args, **kw_args)
(Constructor)

Initialises a new 'DemandResponseProgram' instance.

Parameters:

type - Type of demand response program; examples are CPP (critical-peak pricing), RTP (real-time pricing), DLC (direct load control), DBP (demand bidding program), BIP (base interruptible program). Note that possible types change a lot and it would be impossible to enumerate them all.
CustomerAgreements - All customer agreements with this demand response program.
EndDeviceControls - All end device controls with this demand response program.
validityInterval - Interval within which the program is valid.
EndDeviceGroups - All groups of end devices with this demand response program.

Overrides: object.__init__

Class Variable Details

[hide private]

_many_refs

Value:

['CustomerAgreements', 'EndDeviceControls', 'EndDeviceGroups']

_refs

Value:

['CustomerAgreements',
 'EndDeviceControls',
 'validityInterval',
 'EndDeviceGroups']

Property Details

[hide private]

CustomerAgreements

All customer agreements with this demand response program.

Get Method:: getCustomerAgreements(self) - All customer agreements with this demand response program.
Set Method:: setCustomerAgreements(self, value)

EndDeviceControls

All end device controls with this demand response program.

Get Method:: getEndDeviceControls(self) - All end device controls with this demand response program.
Set Method:: setEndDeviceControls(self, value)

EndDeviceGroups

All groups of end devices with this demand response program.

Get Method:: getEndDeviceGroups(self) - All groups of end devices with this demand response program.
Set Method:: setEndDeviceGroups(self, value)

Class DemandResponseProgram

__init__(self, type='', CustomerAgreements=None, EndDeviceControls=None, validityInterval=None, EndDeviceGroups=None, *args, **kw_args) (Constructor)

_many_refs

_refs

CustomerAgreements

EndDeviceControls

EndDeviceGroups

init(self, type=`''`, CustomerAgreements=None, EndDeviceControls=None, validityInterval=None, EndDeviceGroups=None, *args, **kw_args)
(Constructor)