Trees       Indices       Help   
PyCIM
CIM14 :: CPSM :: Equipment :: Wires :: RegulatingControl :: RegulatingControl :: Class RegulatingControl
[hide private]
[frames] | no frames]

Class RegulatingControl

Core.PowerSystemResource.PowerSystemResource --+
                                               |
                                              RegulatingControl

Specifies a set of equipment that works together to control a power system quantity such as voltage or flow.Although targetRange and targetValue is optional, at least one must be used.

Instance Methods [hide private]
 
__init__(self, targetRange=0.0, mode="reactivePower", discrete=False, targetValue=0.0, RegulationSchedule=None, Terminal=None, RegulatingCondEq=None, TapChanger=None, *args, **kw_args)
Initialises a new 'RegulatingControl' instance.
 
getRegulationSchedule(self)
Schedule for this Regulating regulating control.
 
setRegulationSchedule(self, value)
 
addRegulationSchedule(self, *RegulationSchedule)
 
removeRegulationSchedule(self, *RegulationSchedule)
 
getTerminal(self)
The terminal associated with this regulating control.
 
setTerminal(self, value)
 
getRegulatingCondEq(self)
The equipment that participates in this regulating control scheme.
 
setRegulatingCondEq(self, value)
 
addRegulatingCondEq(self, *RegulatingCondEq)
 
removeRegulatingCondEq(self, *RegulatingCondEq)
 
getTapChanger(self)
copy from reg conduting eq
 
setTapChanger(self, value)
 
addTapChanger(self, *TapChanger)
 
removeTapChanger(self, *TapChanger)
Class Variables [hide private]
  _attrs = ["targetRange", "mode", "discrete", "targetValue"]
  _attr_types = {"targetRange": float, "mode": str, "discrete": ...
  _defaults = {"targetRange": 0.0, "mode": "reactivePower", "dis...
  _enums = {"mode": "RegulatingControlModeKind"}
  _refs = ["RegulationSchedule", "Terminal", "RegulatingCondEq",...
  _many_refs = ["RegulationSchedule", "RegulatingCondEq", "TapCh...
  RegulationSchedule = property(getRegulationSchedule, setRegula...
  Terminal = property(getTerminal, setTerminal)
  RegulatingCondEq = property(getRegulatingCondEq, setRegulating...
  TapChanger = property(getTapChanger, setTapChanger)
Instance Variables [hide private]
  targetRange
This is the case input target range.
  mode
The regulating control mode presently available.
  discrete
The regulation is performed in a discrete mode.
  targetValue
The target value specified for case input.
Method Details [hide private]

__init__(self, targetRange=0.0, mode="reactivePower", discrete=False, targetValue=0.0, RegulationSchedule=None, Terminal=None, RegulatingCondEq=None, TapChanger=None, *args, **kw_args)
(Constructor)

 

Initialises a new 'RegulatingControl' instance.

Parameters:
  • 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.
  • 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: "reactivePower", "timeScheduled", "voltage", "activePower", "currentFlow", "fixed", "temperature", "powerFactor", "admittance"
  • 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.
  • RegulatingCondEq - The equipment that participates in this regulating control scheme.
  • TapChanger - copy from reg conduting eq

Class Variable Details [hide private]

_attr_types

Value:
{"targetRange": float, "mode": str, "discrete": bool, "targetValue": f\
loat}

_defaults

Value:
{"targetRange": 0.0, "mode": "reactivePower", "discrete": False, "targ\
etValue": 0.0}

_refs

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

_many_refs

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

RegulationSchedule

Value:
property(getRegulationSchedule, setRegulationSchedule)

RegulatingCondEq

Value:
property(getRegulatingCondEq, setRegulatingCondEq)

Instance Variable Details [hide private]

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.

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: "reactivePower", "timeScheduled", "voltage", "activePower", "currentFlow", "fixed", "temperature", "powerFactor", "admittance"

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.


   Trees       Indices       Help   
PyCIM
Generated by Epydoc 3.0.1 on Sat Jul 2 18:27:35 2011 http://epydoc.sourceforge.net