CIM14/IEC61970/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.IEC61970.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..
  25     """
  26
  27     def __init__(self, tculControlMode="volt", Winding=None, TransformerWinding=None, RatioVariationCurve=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. Values are: "volt", "reactive"
  31         @param Winding: Winding to which this ratio tap changer belongs.
  32         @param TransformerWinding: The transformer winding to which the ratio tap changer belongs.
  33         @param RatioVariationCurve: A RatioTapChanger can have an associated RatioVariationCurve to define tap ratio variations with tap step changes.
  34         """
  35         #: Specifies the regulation control mode (voltage or reactive) of the RatioTapChanger. Values are: "volt", "reactive"
  36         self.tculControlMode = tculControlMode
  37
  38         self._Winding = None
  39         self.Winding = Winding
  40
  41         self._TransformerWinding = None
  42         self.TransformerWinding = TransformerWinding
  43
  44         self._RatioVariationCurve = None
  45         self.RatioVariationCurve = RatioVariationCurve
  46
  47         super(RatioTapChanger, self).__init__(*args, **kw_args)
  48
  49     _attrs = ["tculControlMode"]
  50     _attr_types = {"tculControlMode": str}
  51     _defaults = {"tculControlMode": "volt"}
  52     _enums = {"tculControlMode": "TransformerControlMode"}
  53     _refs = ["Winding", "TransformerWinding", "RatioVariationCurve"]
  54     _many_refs = []
  55
  56     def getWinding(self):
  57         """Winding to which this ratio tap changer belongs.
  58         """
  59         return self._Winding
  60
  61     def setWinding(self, value):
  62         if self._Winding is not None:
  63             self._Winding._RatioTapChanger = None
  64
  65         self._Winding = value
  66         if self._Winding is not None:
  67             self._Winding.RatioTapChanger = None
  68             self._Winding._RatioTapChanger = self
  69
  70     Winding = property(getWinding, setWinding)
  71
  72     def getTransformerWinding(self):
  73         """The transformer winding to which the ratio tap changer belongs.
  74         """
  75         return self._TransformerWinding
  76
  77     def setTransformerWinding(self, value):
  78         if self._TransformerWinding is not None:
  79             self._TransformerWinding._RatioTapChanger = None
  80
  81         self._TransformerWinding = value
  82         if self._TransformerWinding is not None:
  83             self._TransformerWinding.RatioTapChanger = None
  84             self._TransformerWinding._RatioTapChanger = self
  85
  86     TransformerWinding = property(getTransformerWinding, setTransformerWinding)
  87
  88     def getRatioVariationCurve(self):
  89         """A RatioTapChanger can have an associated RatioVariationCurve to define tap ratio variations with tap step changes.
  90         """
  91         return self._RatioVariationCurve
  92
  93     def setRatioVariationCurve(self, value):
  94         if self._RatioVariationCurve is not None:
  95             self._RatioVariationCurve._RatioTapChanger = None
  96
  97         self._RatioVariationCurve = value
  98         if self._RatioVariationCurve is not None:
  99             self._RatioVariationCurve.RatioTapChanger = None
 100             self._RatioVariationCurve._RatioTapChanger = self
 101
 102     RatioVariationCurve = property(getRatioVariationCurve, setRatioVariationCurve)
 103