Package CIM15 :: Package IEC61970 :: Package Informative :: Package InfLoadControl :: Module LoadMgmtFunction' :: Class LoadMgmtFunction

[frames] | no frames]

Class LoadMgmtFunction

                                object --+                
                                         |                
                          Element'.Element --+            
                                             |            
       Core.IdentifiedObject'.IdentifiedObject --+        
                                                 |        
      IEC61968.Assets.AssetFunction'.AssetFunction --+    
                                                     |    
IEC61968.Metering.EndDeviceFunction'.EndDeviceFunction --+
                                                         |
                                                        LoadMgmtFunction

Known Subclasses:

A collective function at an end device that manages the customer load.A collective function at an end device that manages the customer load.

Instance Methods

[hide private]

__init__(self, schedulingBasis='remoteControl', remoteOverRide=False, isAutoOp=False, loadStatus='limitedLoad', manualOverRide=False, overRideTimeOut=0.0, Switches=None, LoadMgmtRecords=None, *args, **kw_args)
Initialises a new 'LoadMgmtFunction' instance.

addLoadMgmtRecords(self, *LoadMgmtRecords)

addSwitches(self, *Switches)

getLoadMgmtRecords(self)

getSwitches(self)

removeLoadMgmtRecords(self, *LoadMgmtRecords)

removeSwitches(self, *Switches)

setLoadMgmtRecords(self, value)

setSwitches(self, value)

Inherited from IEC61968.Metering.EndDeviceFunction'.EndDeviceFunction: addEndDeviceEvents, addRegisters, getComEquipment, getEndDevice, getEndDeviceEvents, getRegisters, removeEndDeviceEvents, removeRegisters, setComEquipment, setEndDevice, setEndDeviceEvents, setRegisters

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

Inherited from 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 = {'isAutoOp': <type 'bool'>, 'loadStatus': <type ...

_attrs = ['schedulingBasis', 'remoteOverRide', 'isAutoOp', 'lo...

_defaults = {'isAutoOp': False, 'loadStatus': 'limitedLoad', '...

_enums = {'loadStatus': 'LoadStateKind', 'schedulingBasis': 'L...

_many_refs = ['Switches', 'LoadMgmtRecords']

_refs = ['Switches', 'LoadMgmtRecords']

Properties

[hide private]

LoadMgmtRecords

Switches

Inherited from IEC61968.Metering.EndDeviceFunction'.EndDeviceFunction: ComEquipment, EndDevice, EndDeviceEvents, Registers

Inherited from IEC61968.Assets.AssetFunction'.AssetFunction: Asset

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

Inherited from object: __class__

Method Details

[hide private]

init(self, schedulingBasis=`'remoteControl'`, remoteOverRide=False, isAutoOp=False, loadStatus=`'limitedLoad'`, manualOverRide=False, overRideTimeOut=0.0, Switches=None, LoadMgmtRecords=None, *args, **kw_args)
(Constructor)

Initialises a new 'LoadMgmtFunction' instance.

Parameters:

schedulingBasis - The basis of Load Management scheduling used here: Time Based, Tariff Based, Remote Control and Manual Control. Values are: "remoteControl", "timeBased", "tariffBased", "manualControl"
remoteOverRide - True if the currently active schedule is being remotely over-ridden to either shed load or to limit load.
isAutoOp - True if LoadMgmtFunction operates under automatic control, otherwise it operates under manual control.
loadStatus - The present state of the load being either shed (noLoad), limited (limitedLoad) or fully connected (fullLoad). This refers only to the portion of the customer load that is under control of the LoadMgmtFunction. Values are: "limitedLoad", "noLoad", "fullLoad"
manualOverRide - True if the currently active schedule is being manually over-ridden to either shed load or to limit load.
overRideTimeOut - After a command had been received to activate the mannualOverRide state or remoteOverRideState, the normal (halted) schedule will resume after this specified time duration had elapsed.
Switches
LoadMgmtRecords

Overrides: object.__init__

Class Variable Details

[hide private]

_attr_types

Value:

{'isAutoOp': <type 'bool'>,
 'loadStatus': <type 'str'>,
 'manualOverRide': <type 'bool'>,
 'overRideTimeOut': <type 'float'>,
 'remoteOverRide': <type 'bool'>,
 'schedulingBasis': <type 'str'>}

_attrs

Value:

['schedulingBasis',
 'remoteOverRide',
 'isAutoOp',
 'loadStatus',
 'manualOverRide',
 'overRideTimeOut']

_defaults

Value:

{'isAutoOp': False,
 'loadStatus': 'limitedLoad',
 'manualOverRide': False,
 'overRideTimeOut': 0.0,
 'remoteOverRide': False,
 'schedulingBasis': 'remoteControl'}

_enums

Value:

{'loadStatus': 'LoadStateKind', 'schedulingBasis': 'LoadMgmtKind'}

Property Details

[hide private]

LoadMgmtRecords

Get Method:: getLoadMgmtRecords(self)
Set Method:: setLoadMgmtRecords(self, value)

Switches

Get Method:: getSwitches(self)
Set Method:: setSwitches(self, value)

Class LoadMgmtFunction

__init__(self, schedulingBasis='remoteControl', remoteOverRide=False, isAutoOp=False, loadStatus='limitedLoad', manualOverRide=False, overRideTimeOut=0.0, Switches=None, LoadMgmtRecords=None, *args, **kw_args) (Constructor)

_attr_types

_attrs

_defaults

_enums

LoadMgmtRecords

Switches

init(self, schedulingBasis=`'remoteControl'`, remoteOverRide=False, isAutoOp=False, loadStatus=`'limitedLoad'`, manualOverRide=False, overRideTimeOut=0.0, Switches=None, LoadMgmtRecords=None, *args, **kw_args)
(Constructor)