CIM14/CPSM/Equipment/Wires/RatioTapChanger.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.CPSM.Equipment.Wires.TapChanger import TapChanger
  22
  23 class RatioTapChanger(TapChanger):
  24     """A tap changer that changes the voltage ratio impacting the voltage magnitude but not direclty the phase angle across the transformer..-  The attribute ltcflag specifies whether or not a TapChanger has load tap changing capabilities.  If the ltcFlag is true,  the attributes “highStep”, “lowStep”, “neutralStep”, “normalStep”, “neutralU” and “stepVoltageIncrement” are required.
  25     """
  26
  27     def __init__(self, tculControlMode="reactive", RatioVariationCurve=None, TransformerWinding=None, *args, **kw_args):
  28         """Initialises a new 'RatioTapChanger' instance.
  29
  30         @param tculControlMode: Specifies the regulation control mode (voltage or reactive) of the RatioTapChanger.If this is omitted it implies the control mode is OFF.  If the control mode is not OFF, this is required. Values are: "reactive", "volt"
  31         @param RatioVariationCurve: A RatioTapChanger can have an associated RatioVariationCurve to define tap ratio variations with tap step changes.
  32         @param TransformerWinding: The transformer winding to which the ratio tap changer belongs.
  33         """
  34         #: Specifies the regulation control mode (voltage or reactive) of the RatioTapChanger.If this is omitted it implies the control mode is OFF.  If the control mode is not OFF, this is required. Values are: "reactive", "volt"
  35         self.tculControlMode = tculControlMode
  36
  37         self._RatioVariationCurve = None
  38         self.RatioVariationCurve = RatioVariationCurve
  39
  40         self._TransformerWinding = None
  41         self.TransformerWinding = TransformerWinding
  42
  43         super(RatioTapChanger, self).__init__(*args, **kw_args)
  44
  45     _attrs = ["tculControlMode"]
  46     _attr_types = {"tculControlMode": str}
  47     _defaults = {"tculControlMode": "reactive"}
  48     _enums = {"tculControlMode": "TransformerControlMode"}
  49     _refs = ["RatioVariationCurve", "TransformerWinding"]
  50     _many_refs = []
  51
  52     def getRatioVariationCurve(self):
  53         """A RatioTapChanger can have an associated RatioVariationCurve to define tap ratio variations with tap step changes.
  54         """
  55         return self._RatioVariationCurve
  56
  57     def setRatioVariationCurve(self, value):
  58         if self._RatioVariationCurve is not None:
  59             self._RatioVariationCurve._RatioTapChanger = None
  60
  61         self._RatioVariationCurve = value
  62         if self._RatioVariationCurve is not None:
  63             self._RatioVariationCurve.RatioTapChanger = None
  64             self._RatioVariationCurve._RatioTapChanger = self
  65
  66     RatioVariationCurve = property(getRatioVariationCurve, setRatioVariationCurve)
  67
  68     def getTransformerWinding(self):
  69         """The transformer winding to which the ratio tap changer belongs.
  70         """
  71         return self._TransformerWinding
  72
  73     def setTransformerWinding(self, value):
  74         if self._TransformerWinding is not None:
  75             self._TransformerWinding._RatioTapChanger = None
  76
  77         self._TransformerWinding = value
  78         if self._TransformerWinding is not None:
  79             self._TransformerWinding.RatioTapChanger = None
  80             self._TransformerWinding._RatioTapChanger = self
  81
  82     TransformerWinding = property(getTransformerWinding, setTransformerWinding)
  83