CIM14/IEC61970/Wires/TapSchedule.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.LoadModel.SeasonDayTypeSchedule import SeasonDayTypeSchedule
  22
  23 class TapSchedule(SeasonDayTypeSchedule):
  24     """A pre-established pattern over time for a tap step.
  25     """
  26
  27     def __init__(self, lineDropCompensation=False, lineDropR=0.0, lineDropX=0.0, TapChanger=None, *args, **kw_args):
  28         """Initialises a new 'TapSchedule' instance.
  29
  30         @param lineDropCompensation: Flag to indicate that line drop compensation is to be applied
  31         @param lineDropR: Line drop resistance.
  32         @param lineDropX: Line drop reactance.
  33         @param TapChanger: A TapSchedule is associated with a TapChanger.
  34         """
  35         #: Flag to indicate that line drop compensation is to be applied
  36         self.lineDropCompensation = lineDropCompensation
  37
  38         #: Line drop resistance.
  39         self.lineDropR = lineDropR
  40
  41         #: Line drop reactance.
  42         self.lineDropX = lineDropX
  43
  44         self._TapChanger = None
  45         self.TapChanger = TapChanger
  46
  47         super(TapSchedule, self).__init__(*args, **kw_args)
  48
  49     _attrs = ["lineDropCompensation", "lineDropR", "lineDropX"]
  50     _attr_types = {"lineDropCompensation": bool, "lineDropR": float, "lineDropX": float}
  51     _defaults = {"lineDropCompensation": False, "lineDropR": 0.0, "lineDropX": 0.0}
  52     _enums = {}
  53     _refs = ["TapChanger"]
  54     _many_refs = []
  55
  56     def getTapChanger(self):
  57         """A TapSchedule is associated with a TapChanger.
  58         """
  59         return self._TapChanger
  60
  61     def setTapChanger(self, value):
  62         if self._TapChanger is not None:
  63             filtered = [x for x in self.TapChanger.TapSchedules if x != self]
  64             self._TapChanger._TapSchedules = filtered
  65
  66         self._TapChanger = value
  67         if self._TapChanger is not None:
  68             if self not in self._TapChanger._TapSchedules:
  69                 self._TapChanger._TapSchedules.append(self)
  70
  71     TapChanger = property(getTapChanger, setTapChanger)
  72