Update README.rst
[PyCIM.git] / CIM14 / CDPSM / Unbalanced / IEC61970 / Wires / RatioTapChanger.py
blobf89e2efd916c64d8bf7d75c7e91ccd9b23e5cb70
1 # Copyright (C) 2010-2011 Richard Lincoln
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:
10 # The above copyright notice and this permission notice shall be included in
11 # all copies or substantial portions of the Software.
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.
21 from CIM14.CDPSM.Unbalanced.IEC61970.Wires.TapChanger import TapChanger
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 """
27 def __init__(self, tculControlMode="reactive", Winding=None, *args, **kw_args):
28 """Initialises a new 'RatioTapChanger' instance.
30 @param tculControlMode: Specifies the regulation control mode (voltage or reactive) of the RatioTapChanger. Values are: "reactive", "volt"
31 @param Winding: Winding to which this ratio tap changer belongs.
32 """
33 #: Specifies the regulation control mode (voltage or reactive) of the RatioTapChanger. Values are: "reactive", "volt"
34 self.tculControlMode = tculControlMode
36 self._Winding = None
37 self.Winding = Winding
39 super(RatioTapChanger, self).__init__(*args, **kw_args)
41 _attrs = ["tculControlMode"]
42 _attr_types = {"tculControlMode": str}
43 _defaults = {"tculControlMode": "reactive"}
44 _enums = {"tculControlMode": "TransformerControlMode"}
45 _refs = ["Winding"]
46 _many_refs = []
48 def getWinding(self):
49 """Winding to which this ratio tap changer belongs.
50 """
51 return self._Winding
53 def setWinding(self, value):
54 if self._Winding is not None:
55 self._Winding._RatioTapChanger = None
57 self._Winding = value
58 if self._Winding is not None:
59 self._Winding.RatioTapChanger = None
60 self._Winding._RatioTapChanger = self
62 Winding = property(getWinding, setWinding)