CIM14/ENTSOE/Equipment/Core/CurveData.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.ENTSOE.Equipment.Element import Element
  22
  23 class CurveData(Element):
  24     """Multi-purpose data points for defining a curve.-  The CurveData class is used to represent points for various curves that derive from the Curve class.  The curves defined in this profile are:       GrossToNetActivePowerCurve      ReactiveCapabilityCurve
  25     """
  26
  27     def __init__(self, y1value=0.0, xvalue=0.0, y2value=0.0, Curve=None, *args, **kw_args):
  28         """Initialises a new 'CurveData' instance.
  29
  30         @param y1value: The data value of the  first Y-axis variable, depending on the Y-axis units
  31         @param xvalue: The data value of the X-axis variable,  depending on the X-axis units
  32         @param y2value: The data value of the second Y-axis variable (if present), depending on the Y-axis units
  33         @param Curve: The Curve defined by this CurveData.
  34         """
  35         #: The data value of the  first Y-axis variable, depending on the Y-axis units
  36         self.y1value = y1value
  37
  38         #: The data value of the X-axis variable,  depending on the X-axis units
  39         self.xvalue = xvalue
  40
  41         #: The data value of the second Y-axis variable (if present), depending on the Y-axis units
  42         self.y2value = y2value
  43
  44         self._Curve = None
  45         self.Curve = Curve
  46
  47         super(CurveData, self).__init__(*args, **kw_args)
  48
  49     _attrs = ["y1value", "xvalue", "y2value"]
  50     _attr_types = {"y1value": float, "xvalue": float, "y2value": float}
  51     _defaults = {"y1value": 0.0, "xvalue": 0.0, "y2value": 0.0}
  52     _enums = {}
  53     _refs = ["Curve"]
  54     _many_refs = []
  55
  56     def getCurve(self):
  57         """The Curve defined by this CurveData.
  58         """
  59         return self._Curve
  60
  61     def setCurve(self, value):
  62         if self._Curve is not None:
  63             filtered = [x for x in self.Curve.CurveDatas if x != self]
  64             self._Curve._CurveDatas = filtered
  65
  66         self._Curve = value
  67         if self._Curve is not None:
  68             if self not in self._Curve._CurveDatas:
  69                 self._Curve._CurveDatas.append(self)
  70
  71     Curve = property(getCurve, setCurve)
  72