CIM14/IEC61970/Wires/RatioVariationCurve.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.Core.Curve import Curve
  22
  23 class RatioVariationCurve(Curve):
  24     """A Ratio Variation Curve describes the change in tap ratio in relationship to tap step changes.  The tap step is represented using the xValue and the ratio using y1value.
  25     """
  26
  27     def __init__(self, RatioTapChanger=None, *args, **kw_args):
  28         """Initialises a new 'RatioVariationCurve' instance.
  29
  30         @param RatioTapChanger: A RatioVariationCurve defines tap ratio changes for a RatioTapChanger.
  31         """
  32         self._RatioTapChanger = None
  33         self.RatioTapChanger = RatioTapChanger
  34
  35         super(RatioVariationCurve, self).__init__(*args, **kw_args)
  36
  37     _attrs = []
  38     _attr_types = {}
  39     _defaults = {}
  40     _enums = {}
  41     _refs = ["RatioTapChanger"]
  42     _many_refs = []
  43
  44     def getRatioTapChanger(self):
  45         """A RatioVariationCurve defines tap ratio changes for a RatioTapChanger.
  46         """
  47         return self._RatioTapChanger
  48
  49     def setRatioTapChanger(self, value):
  50         if self._RatioTapChanger is not None:
  51             self._RatioTapChanger._RatioVariationCurve = None
  52
  53         self._RatioTapChanger = value
  54         if self._RatioTapChanger is not None:
  55             self._RatioTapChanger.RatioVariationCurve = None
  56             self._RatioTapChanger._RatioVariationCurve = self
  57
  58     RatioTapChanger = property(getRatioTapChanger, setRatioTapChanger)
  59