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

Class RegulatingControl

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

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, RegulationSchedule=None, Terminal=None, TapChanger=None, RegulatingCondEq=None, *args, **kw_args)
Initialises a new 'RegulatingControl' instance.
 
addRegulatingCondEq(self, *RegulatingCondEq)
 
addRegulationSchedule(self, *RegulationSchedule)
 
addTapChanger(self, *TapChanger)
 
getRegulatingCondEq(self)
The equipment that participates in this regulating control scheme.
 
getRegulationSchedule(self)
Schedule for this Regulating regulating control.
 
getTapChanger(self)
copy from reg conduting eq
 
getTerminal(self)
The terminal associated with this regulating control.
 
removeRegulatingCondEq(self, *RegulatingCondEq)
 
removeRegulationSchedule(self, *RegulationSchedule)
 
removeTapChanger(self, *TapChanger)
 
setRegulatingCondEq(self, value)
 
setRegulationSchedule(self, value)
 
setTapChanger(self, value)
 
setTerminal(self, value)

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 = {'discrete': <type 'bool'>, 'mode': <type 'str'>...
  _attrs = ['mode', 'targetRange', 'discrete', 'targetValue']
  _defaults = {'discrete': False, 'mode': 'fixed', 'targetRange'...
  _enums = {'mode': 'RegulatingControlModeKind'}
  _many_refs = ['RegulationSchedule', 'TapChanger', 'RegulatingC...
  _refs = ['RegulationSchedule', 'Terminal', 'TapChanger', 'Regu...
Properties [hide private]
  RegulatingCondEq
The equipment that participates in this regulating control scheme.
  RegulationSchedule
Schedule for this Regulating regulating control.
  TapChanger
copy from reg conduting eq
  Terminal
The terminal associated with this regulating control.

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, mode='fixed', targetRange=0.0, discrete=False, targetValue=0.0, RegulationSchedule=None, Terminal=None, TapChanger=None, RegulatingCondEq=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", "voltage", "timeScheduled", "currentFlow", "admittance", "powerFactor", "activePower", "reactivePower", "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.
  • RegulationSchedule - Schedule for this Regulating regulating control.
  • Terminal - The terminal associated with this regulating control.
  • TapChanger - copy from reg conduting eq
  • RegulatingCondEq - The equipment that participates in this regulating control scheme.
Overrides: object.__init__

Class Variable Details [hide private]

_attr_types

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

_defaults

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

_many_refs

Value:
['RegulationSchedule', 'TapChanger', 'RegulatingCondEq']

_refs

Value:
['RegulationSchedule', 'Terminal', 'TapChanger', 'RegulatingCondEq']

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)

TapChanger

copy from reg conduting eq

Get Method:
getTapChanger(self) - copy from reg conduting eq
Set Method:
setTapChanger(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)