CIM14/CPSM/Equipment/Wires/PowerTransformer.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.Core.Equipment import Equipment
  22
  23 class PowerTransformer(Equipment):
  24     """An electrical device consisting of  two or more coupled windings, with or without a magnetic core, for introducing mutual coupling between electric circuits. Transformers can be used to control voltage and phase shift (active power flow).A PowerTransformer can be either two winding or three winding. -  A two winding transformer has two TransformerWindings -  A three winding transformer has three TransformerWindings
  25     """
  26
  27     def __init__(self, TransformerWindings=None, *args, **kw_args):
  28         """Initialises a new 'PowerTransformer' instance.
  29
  30         @param TransformerWindings: A transformer has windings
  31         """
  32         self._TransformerWindings = []
  33         self.TransformerWindings = [] if TransformerWindings is None else TransformerWindings
  34
  35         super(PowerTransformer, self).__init__(*args, **kw_args)
  36
  37     _attrs = []
  38     _attr_types = {}
  39     _defaults = {}
  40     _enums = {}
  41     _refs = ["TransformerWindings"]
  42     _many_refs = ["TransformerWindings"]
  43
  44     def getTransformerWindings(self):
  45         """A transformer has windings
  46         """
  47         return self._TransformerWindings
  48
  49     def setTransformerWindings(self, value):
  50         for x in self._TransformerWindings:
  51             x.PowerTransformer = None
  52         for y in value:
  53             y._PowerTransformer = self
  54         self._TransformerWindings = value
  55
  56     TransformerWindings = property(getTransformerWindings, setTransformerWindings)
  57
  58     def addTransformerWindings(self, *TransformerWindings):
  59         for obj in TransformerWindings:
  60             obj.PowerTransformer = self
  61
  62     def removeTransformerWindings(self, *TransformerWindings):
  63         for obj in TransformerWindings:
  64             obj.PowerTransformer = None
  65