Package CIM15 :: Package IEC61970 :: Package Wires :: Module EnergyConsumer' :: Class EnergyConsumer

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 modelGeneric user of energy - a point of consumption on the power system model

Instance Methods

[hide private]

__init__(self, qfixedPct=0.0, customerCount=0, pfixedPct=0.0, pfixed=0.0, qfixed=0.0, ServiceDeliveryPoints=None, LoadResponse=None, PowerCutZone=None, EnergyConsumerPhases=None, *args, **kw_args)
Initialises a new 'EnergyConsumer' instance.

addEnergyConsumerPhases(self, *EnergyConsumerPhases)

addServiceDeliveryPoints(self, *ServiceDeliveryPoints)

getEnergyConsumerPhases(self)

getLoadResponse(self)
The load response characteristic of this load.

getPowerCutZone(self)
An energy consumer is assigned to a power cut zone

getServiceDeliveryPoints(self)

removeEnergyConsumerPhases(self, *EnergyConsumerPhases)

removeServiceDeliveryPoints(self, *ServiceDeliveryPoints)

setEnergyConsumerPhases(self, value)

setLoadResponse(self, value)

setPowerCutZone(self, value)

setServiceDeliveryPoints(self, value)

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

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

Inherited from Core.PowerSystemResource'.PowerSystemResource: addAssets, addChangeItems, addDocumentRoles, addErpOrganisationRoles, addMeasurements, addNetworkDataSets, addOperatingShare, addPSREvent, addPsrLists, addReportingGroup, addSafetyDocuments, addScheduleSteps, getAssets, getChangeItems, getDocumentRoles, getErpOrganisationRoles, getLocation, getMeasurements, getNetworkDataSets, getOperatingShare, getOutageSchedule, getPSREvent, getPSRType, getPsrLists, getReportingGroup, getSafetyDocuments, getScheduleSteps, removeAssets, removeChangeItems, removeDocumentRoles, removeErpOrganisationRoles, removeMeasurements, removeNetworkDataSets, removeOperatingShare, removePSREvent, removePsrLists, removeReportingGroup, removeSafetyDocuments, removeScheduleSteps, setAssets, setChangeItems, setDocumentRoles, setErpOrganisationRoles, setLocation, setMeasurements, setNetworkDataSets, setOperatingShare, setOutageSchedule, setPSREvent, setPSRType, setPsrLists, setReportingGroup, setSafetyDocuments, setScheduleSteps

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

_attrs = ['qfixedPct', 'customerCount', 'pfixedPct', 'pfixed',...

_defaults = {'customerCount': 0, 'pfixed': 0.0, 'pfixedPct': 0...

_many_refs = ['ServiceDeliveryPoints', 'EnergyConsumerPhases']

_refs = ['ServiceDeliveryPoints', 'LoadResponse', 'PowerCutZon...

Inherited from Element'.Element (private): _enums

Properties

[hide private]

EnergyConsumerPhases

LoadResponse
The load response characteristic of this load.

PowerCutZone
An energy consumer is assigned to a power cut zone

ServiceDeliveryPoints

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

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

Inherited from Core.PowerSystemResource'.PowerSystemResource: Assets, ChangeItems, DocumentRoles, ErpOrganisationRoles, Location, Measurements, NetworkDataSets, OperatingShare, OutageSchedule, PSREvent, PSRType, PsrLists, ReportingGroup, SafetyDocuments, ScheduleSteps

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

Inherited from object: __class__

Method Details

[hide private]

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

Initialises a new 'EnergyConsumer' instance.

Parameters:

qfixedPct - Fixed reactive power as per cent of load group fixed reactive power. Load sign convention is used, i.e. positive sign means flow out from a node.
customerCount - Number of individual customers represented by this Demand
pfixedPct - Fixed active power as per cent of load group fixed active power. Load sign convention is used, i.e. positive sign means flow out from a node.
pfixed - Active power of the load that is a fixed quantity. Load sign convention is used, i.e. positive sign means flow out from a node.
qfixed - Reactive power of the load that is a fixed quantity. Load sign convention is used, i.e. positive sign means flow out from a node.
ServiceDeliveryPoints
LoadResponse - The load response characteristic of this load.
PowerCutZone - An energy consumer is assigned to a power cut zone
EnergyConsumerPhases

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:

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

_defaults

Value:

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

_refs

Value:

['ServiceDeliveryPoints',
 'LoadResponse',
 'PowerCutZone',
 'EnergyConsumerPhases']

Property Details

[hide private]

EnergyConsumerPhases

Get Method:: getEnergyConsumerPhases(self)
Set Method:: setEnergyConsumerPhases(self, value)

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)

Class EnergyConsumer

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

_attr_types

_attrs

_defaults

_refs

EnergyConsumerPhases

LoadResponse

PowerCutZone

ServiceDeliveryPoints

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