Package CIM14 :: Package IEC61970 :: Package Wires :: Module EnergyConsumer' :: Class EnergyConsumer
[hide private]
[frames] | no frames]

Class EnergyConsumer

                           object --+                    
                                    |                    
                     Element'.Element --+                
                                        |                
  Core.IdentifiedObject'.IdentifiedObject --+            
                                            |            
Core.PowerSystemResource'.PowerSystemResource --+        
                                                |        
                        Core.Equipment'.Equipment --+    
                                                    |    
        Core.ConductingEquipment'.ConductingEquipment --+
                                                        |
                                                       EnergyConsumer
Known Subclasses:

Generic user of energy - a point of consumption on the power system model

Instance Methods [hide private]
 
__init__(self, customerCount=0, qfixedPct=0.0, pfixed=0.0, pfixedPct=0.0, qfixed=0.0, aggregateLoad0=None, PowerCutZone=None, ServiceDeliveryPoints=None, LoadResponse=None, *args, **kw_args)
Initialises a new 'EnergyConsumer' instance.
 
addServiceDeliveryPoints(self, *ServiceDeliveryPoints)
 
addaggregateLoad0(self, *aggregateLoad0)
 
getLoadResponse(self)
The load response characteristic of this load.
 
getPowerCutZone(self)
An energy consumer is assigned to a power cut zone
 
getServiceDeliveryPoints(self)
 
getaggregateLoad0(self)
 
removeServiceDeliveryPoints(self, *ServiceDeliveryPoints)
 
removeaggregateLoad0(self, *aggregateLoad0)
 
setLoadResponse(self, value)
 
setPowerCutZone(self, value)
 
setServiceDeliveryPoints(self, value)
 
setaggregateLoad0(self, value)

Inherited from Core.ConductingEquipment'.ConductingEquipment: addClearanceTags, addProtectionEquipments, addTerminals, getBaseVoltage, getClearanceTags, getProtectionEquipments, getSvStatus, getTerminals, removeClearanceTags, removeProtectionEquipments, removeTerminals, setBaseVoltage, setClearanceTags, setProtectionEquipments, setSvStatus, setTerminals

Inherited from Core.Equipment'.Equipment: addContingencyEquipment, addCustomerAgreements, addOperationalLimitSet, getContingencyEquipment, getCustomerAgreements, getEquipmentContainer, getOperationalLimitSet, removeContingencyEquipment, removeCustomerAgreements, removeOperationalLimitSet, setContingencyEquipment, setCustomerAgreements, setEquipmentContainer, setOperationalLimitSet

Inherited from Core.PowerSystemResource'.PowerSystemResource: addAssets, addBlock, addMeasurements, addOperatingShare, addPsrLists, addReportingGroup, getAssets, getBlock, getLocation, getMeasurements, getOperatingShare, getOutageSchedule, getPSRType, getPsrLists, getReportingGroup, removeAssets, removeBlock, removeMeasurements, removeOperatingShare, removePsrLists, removeReportingGroup, setAssets, setBlock, setLocation, setMeasurements, setOperatingShare, setOutageSchedule, setPSRType, setPsrLists, setReportingGroup

Inherited from 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 = {'customerCount': <type 'int'>, 'pfixed': <type ...
  _attrs = ['customerCount', 'qfixedPct', 'pfixed', 'pfixedPct',...
  _defaults = {'customerCount': 0, 'pfixed': 0.0, 'pfixedPct': 0...
  _enums = {}
  _many_refs = ['aggregateLoad0', 'ServiceDeliveryPoints']
  _refs = ['aggregateLoad0', 'PowerCutZone', 'ServiceDeliveryPoi...
Properties [hide private]
  LoadResponse
The load response characteristic of this load.
  PowerCutZone
An energy consumer is assigned to a power cut zone
  ServiceDeliveryPoints
  aggregateLoad0

Inherited from Core.ConductingEquipment'.ConductingEquipment: BaseVoltage, ClearanceTags, ProtectionEquipments, SvStatus, Terminals

Inherited from Core.Equipment'.Equipment: ContingencyEquipment, CustomerAgreements, EquipmentContainer, OperationalLimitSet

Inherited from Core.PowerSystemResource'.PowerSystemResource: Assets, Block, Location, Measurements, OperatingShare, OutageSchedule, PSRType, PsrLists, ReportingGroup

Inherited from Core.IdentifiedObject'.IdentifiedObject: ModelingAuthoritySet

Inherited from object: __class__

Method Details [hide private]

__init__(self, customerCount=0, qfixedPct=0.0, pfixed=0.0, pfixedPct=0.0, qfixed=0.0, aggregateLoad0=None, PowerCutZone=None, ServiceDeliveryPoints=None, LoadResponse=None, *args, **kw_args)
(Constructor)

 

Initialises a new 'EnergyConsumer' instance.

Parameters:
  • customerCount - Number of individual customers represented by this Demand
  • qfixedPct - Fixed reactive power as per cent of load group fixed reactive power.
  • pfixed - Active power of the load that is a fixed quantity.
  • pfixedPct - Fixed active power as per cent of load group fixed active power
  • qfixed - Reactive power of the load that is a fixed quantity.
  • aggregateLoad0
  • PowerCutZone - An energy consumer is assigned to a power cut zone
  • ServiceDeliveryPoints
  • LoadResponse - The load response characteristic of this load.
Overrides: object.__init__

Class Variable Details [hide private]

_attr_types

Value:
{'customerCount': <type 'int'>,
 'pfixed': <type 'float'>,
 'pfixedPct': <type 'float'>,
 'qfixed': <type 'float'>,
 'qfixedPct': <type 'float'>}

_attrs

Value:
['customerCount', 'qfixedPct', 'pfixed', 'pfixedPct', 'qfixed']

_defaults

Value:
{'customerCount': 0,
 'pfixed': 0.0,
 'pfixedPct': 0.0,
 'qfixed': 0.0,
 'qfixedPct': 0.0}

_refs

Value:
['aggregateLoad0',
 'PowerCutZone',
 'ServiceDeliveryPoints',
 'LoadResponse']

Property Details [hide private]

LoadResponse

The load response characteristic of this load.

Get Method:
getLoadResponse(self) - The load response characteristic of this load.
Set Method:
setLoadResponse(self, value)

PowerCutZone

An energy consumer is assigned to a power cut zone

Get Method:
getPowerCutZone(self) - An energy consumer is assigned to a power cut zone
Set Method:
setPowerCutZone(self, value)

ServiceDeliveryPoints

Get Method:
getServiceDeliveryPoints(self)
Set Method:
setServiceDeliveryPoints(self, value)

aggregateLoad0

Get Method:
getaggregateLoad0(self)
Set Method:
setaggregateLoad0(self, value)