CIM14/IEC61970/Wires/RegulatingCondEq.py

   1 # Copyright (C) 2010-2011 Richard Lincoln
   2 #
   3 # Permission is hereby granted, free of charge, to any person obtaining a copy
   4 # of this software and associated documentation files (the "Software"), to
   5 # deal in the Software without restriction, including without limitation the
   6 # rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
   7 # sell copies of the Software, and to permit persons to whom the Software is
   8 # furnished to do so, subject to the following conditions:
   9 #
  10 # The above copyright notice and this permission notice shall be included in
  11 # all copies or substantial portions of the Software.
  12 #
  13 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  14 # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  15 # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  16 # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  17 # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  18 # FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
  19 # IN THE SOFTWARE.
  20
  21 from CIM14.IEC61970.Core.ConductingEquipment import ConductingEquipment
  22
  23 class RegulatingCondEq(ConductingEquipment):
  24     """A type of conducting equipment that can regulate a quanity (i.e. voltage or flow) at a specific point in the network.
  25     """
  26
  27     def __init__(self, Controls=None, RegulatingControl=None, *args, **kw_args):
  28         """Initialises a new 'RegulatingCondEq' instance.
  29
  30         @param Controls: The controller outputs used to actually govern a regulating device, e.g. the magnetization of a synchronous machine or capacitor bank breaker actuator.
  31         @param RegulatingControl: The regulating control scheme in which this equipment participates.
  32         """
  33         self._Controls = []
  34         self.Controls = [] if Controls is None else Controls
  35
  36         self._RegulatingControl = None
  37         self.RegulatingControl = RegulatingControl
  38
  39         super(RegulatingCondEq, self).__init__(*args, **kw_args)
  40
  41     _attrs = []
  42     _attr_types = {}
  43     _defaults = {}
  44     _enums = {}
  45     _refs = ["Controls", "RegulatingControl"]
  46     _many_refs = ["Controls"]
  47
  48     def getControls(self):
  49         """The controller outputs used to actually govern a regulating device, e.g. the magnetization of a synchronous machine or capacitor bank breaker actuator.
  50         """
  51         return self._Controls
  52
  53     def setControls(self, value):
  54         for x in self._Controls:
  55             x.RegulatingCondEq = None
  56         for y in value:
  57             y._RegulatingCondEq = self
  58         self._Controls = value
  59
  60     Controls = property(getControls, setControls)
  61
  62     def addControls(self, *Controls):
  63         for obj in Controls:
  64             obj.RegulatingCondEq = self
  65
  66     def removeControls(self, *Controls):
  67         for obj in Controls:
  68             obj.RegulatingCondEq = None
  69
  70     def getRegulatingControl(self):
  71         """The regulating control scheme in which this equipment participates.
  72         """
  73         return self._RegulatingControl
  74
  75     def setRegulatingControl(self, value):
  76         if self._RegulatingControl is not None:
  77             filtered = [x for x in self.RegulatingControl.RegulatingCondEq if x != self]
  78             self._RegulatingControl._RegulatingCondEq = filtered
  79
  80         self._RegulatingControl = value
  81         if self._RegulatingControl is not None:
  82             if self not in self._RegulatingControl._RegulatingCondEq:
  83                 self._RegulatingControl._RegulatingCondEq.append(self)
  84
  85     RegulatingControl = property(getRegulatingControl, setRegulatingControl)
  86