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

Class RegulatingControl

                           object --+            
                                    |            
                     Element'.Element --+        
                                        |        
  Core.IdentifiedObject'.IdentifiedObject --+    
                                            |    
Core.PowerSystemResource'.PowerSystemResource --+
                                                |
                                               RegulatingControl

Known Subclasses:

TapChangerControl'.TapChangerControl

Specifies a set of equipment that works together to control a power system quantity such as voltage or flow.Specifies a set of equipment that works together to control a power system quantity such as voltage or flow.

Instance Methods

[hide private]

__init__(self, mode='fixed', targetRange=0.0, discrete=False, targetValue=0.0, monitoredPhase='s12N', RegulatingCondEq=None, Terminal=None, RegulationSchedule=None, *args, **kw_args)
Initialises a new 'RegulatingControl' instance.

addRegulatingCondEq(self, *RegulatingCondEq)

addRegulationSchedule(self, *RegulationSchedule)

getRegulatingCondEq(self)
The equipment that participates in this regulating control scheme.

getRegulationSchedule(self)
Schedule for this Regulating regulating control.

getTerminal(self)
The terminal associated with this regulating control.

removeRegulatingCondEq(self, *RegulatingCondEq)

removeRegulationSchedule(self, *RegulationSchedule)

setRegulatingCondEq(self, value)

setRegulationSchedule(self, value)

setTerminal(self, value)

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 = {'discrete': <type 'bool'>, 'mode': <type 'str'>...

_attrs = ['mode', 'targetRange', 'discrete', 'targetValue', 'm...

_defaults = {'discrete': False, 'mode': 'fixed', 'monitoredPha...

_enums = {'mode': 'RegulatingControlModeKind', 'monitoredPhase...

_many_refs = ['RegulatingCondEq', 'RegulationSchedule']

_refs = ['RegulatingCondEq', 'Terminal', 'RegulationSchedule']

Properties

[hide private]

RegulatingCondEq
The equipment that participates in this regulating control scheme.

RegulationSchedule
Schedule for this Regulating regulating control.

Terminal
The terminal associated with this regulating control.

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, mode=`'fixed'`, targetRange=0.0, discrete=False, targetValue=0.0, monitoredPhase=`'s12N'`, RegulatingCondEq=None, Terminal=None, RegulationSchedule=None, *args, **kw_args)
(Constructor)

Initialises a new 'RegulatingControl' instance.

Parameters:

mode - The regulating control mode presently available. This specifications allows for determining the kind of regualation without need for obtaining the units from a schedule. Values are: "fixed", "timeScheduled", "voltage", "admittance", "reactivePower", "powerFactor", "currentFlow", "activePower", "temperature"
targetRange - This is the case input target range. This performs the same function as the value2 attribute on the regulation schedule in the case that schedules are not used. The units of those appropriate for the mode.
discrete - The regulation is performed in a discrete mode.
targetValue - The target value specified for case input. This value can be used for the target value wihout the use of schedules. The value has the units appropriate to the mode attribute.
monitoredPhase - Phase voltage controlling this regulator, measured at regulator location. Values are: "s12N", "BN", "BC", "ABN", "s2N", "N", "ACN", "BCN", "ABCN", "AC", "s1N", "AN", "B", "AB", "C", "A", "CN", "ABC"
RegulatingCondEq - The equipment that participates in this regulating control scheme.
Terminal - The terminal associated with this regulating control.
RegulationSchedule - Schedule for this Regulating regulating control.

Overrides: object.__init__

Class Variable Details

[hide private]

_attr_types

Value:

{'discrete': <type 'bool'>,
 'mode': <type 'str'>,
 'monitoredPhase': <type 'str'>,
 'targetRange': <type 'float'>,
 'targetValue': <type 'float'>}

_attrs

Value:

['mode', 'targetRange', 'discrete', 'targetValue', 'monitoredPhase']

_defaults

Value:

{'discrete': False,
 'mode': 'fixed',
 'monitoredPhase': 's12N',
 'targetRange': 0.0,
 'targetValue': 0.0}

_enums

Value:

{'mode': 'RegulatingControlModeKind', 'monitoredPhase': 'PhaseCode'}

Property Details

[hide private]

RegulatingCondEq

The equipment that participates in this regulating control scheme.

Get Method:: getRegulatingCondEq(self) - The equipment that participates in this regulating control scheme.
Set Method:: setRegulatingCondEq(self, value)

RegulationSchedule

Schedule for this Regulating regulating control.

Get Method:: getRegulationSchedule(self) - Schedule for this Regulating regulating control.
Set Method:: setRegulationSchedule(self, value)

Terminal

The terminal associated with this regulating control.

Get Method:: getTerminal(self) - The terminal associated with this regulating control.
Set Method:: setTerminal(self, value)

Class RegulatingControl

__init__(self, mode='fixed', targetRange=0.0, discrete=False, targetValue=0.0, monitoredPhase='s12N', RegulatingCondEq=None, Terminal=None, RegulationSchedule=None, *args, **kw_args) (Constructor)

_attr_types

_attrs

_defaults

_enums

RegulatingCondEq

RegulationSchedule

Terminal

init(self, mode=`'fixed'`, targetRange=0.0, discrete=False, targetValue=0.0, monitoredPhase=`'s12N'`, RegulatingCondEq=None, Terminal=None, RegulationSchedule=None, *args, **kw_args)
(Constructor)