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