CDPSM/Connectivity/IEC61970/Wires/TransformerTankEnd.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 CDPSM.Connectivity.IEC61970.Wires.TransformerEnd import TransformerEnd
  22
  23 class TransformerTankEnd(TransformerEnd):
  24     """Transformer tank end represents an individual winding for unbalanced models or for transformer tanks connected into a bank (and bank is modelled with the PowerTransformer).
  25     """
  26
  27     def __init__(self, phases="s12N", TransformerTank=None, *args, **kw_args):
  28         """Initialises a new 'TransformerTankEnd' instance.
  29
  30         @param phases: Describes the phases carried by a conducting equipment. Values are: "s12N", "BN", "BC", "ABN", "s2N", "N", "ACN", "BCN", "ABCN", "AC", "s1N", "AN", "B", "AB", "C", "A", "CN", "ABC"
  31         @param TransformerTank: Transformer this winding belongs to.
  32         """
  33         #: Describes the phases carried by a conducting equipment. Values are: "s12N", "BN", "BC", "ABN", "s2N", "N", "ACN", "BCN", "ABCN", "AC", "s1N", "AN", "B", "AB", "C", "A", "CN", "ABC"
  34         self.phases = phases
  35
  36         self._TransformerTank = None
  37         self.TransformerTank = TransformerTank
  38
  39         super(TransformerTankEnd, self).__init__(*args, **kw_args)
  40
  41     _attrs = ["phases"]
  42     _attr_types = {"phases": str}
  43     _defaults = {"phases": "s12N"}
  44     _enums = {"phases": "PhaseCode"}
  45     _refs = ["TransformerTank"]
  46     _many_refs = []
  47
  48     def getTransformerTank(self):
  49         """Transformer this winding belongs to.
  50         """
  51         return self._TransformerTank
  52
  53     def setTransformerTank(self, value):
  54         if self._TransformerTank is not None:
  55             filtered = [x for x in self.TransformerTank.TransformerTankEnds if x != self]
  56             self._TransformerTank._TransformerTankEnds = filtered
  57
  58         self._TransformerTank = value
  59         if self._TransformerTank is not None:
  60             if self not in self._TransformerTank._TransformerTankEnds:
  61                 self._TransformerTank._TransformerTankEnds.append(self)
  62
  63     TransformerTank = property(getTransformerTank, setTransformerTank)
  64