CIM14/IEC61970/Core/RegularTimePoint.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 RegularTimePoint(Element):
  24     """TimePoints for a schedule where the time between the points is constant.
  25     """
  26
  27     def __init__(self, value1=0.0, sequenceNumber=0, value2=0.0, IntervalSchedule=None, *args, **kw_args):
  28         """Initialises a new 'RegularTimePoint' instance.
  29
  30         @param value1: The first value at the time. The meaning of the value is defined by the class inhering the RegularIntervalSchedule.
  31         @param sequenceNumber: The position of the RegularTimePoint in the sequence. Note that time points don't have to be sequential, i.e. time points may be omitted. The actual time for a RegularTimePoint is computed by multiplying the RegularIntervalSchedule.timeStep with the RegularTimePoint.sequenceNumber and add the BasicIntervalSchedule.startTime.
  32         @param value2: The second value at the time. The meaning of the value is defined by the class inhering the RegularIntervalSchedule.
  33         @param IntervalSchedule: A RegularTimePoint belongs to a RegularIntervalSchedule.
  34         """
  35         #: The first value at the time. The meaning of the value is defined by the class inhering the RegularIntervalSchedule.
  36         self.value1 = value1
  37
  38         #: The position of the RegularTimePoint in the sequence. Note that time points don't have to be sequential, i.e. time points may be omitted. The actual time for a RegularTimePoint is computed by multiplying the RegularIntervalSchedule.timeStep with the RegularTimePoint.sequenceNumber and add the BasicIntervalSchedule.startTime.
  39         self.sequenceNumber = sequenceNumber
  40
  41         #: The second value at the time. The meaning of the value is defined by the class inhering the RegularIntervalSchedule.
  42         self.value2 = value2
  43
  44         self._IntervalSchedule = None
  45         self.IntervalSchedule = IntervalSchedule
  46
  47         super(RegularTimePoint, self).__init__(*args, **kw_args)
  48
  49     _attrs = ["value1", "sequenceNumber", "value2"]
  50     _attr_types = {"value1": float, "sequenceNumber": int, "value2": float}
  51     _defaults = {"value1": 0.0, "sequenceNumber": 0, "value2": 0.0}
  52     _enums = {}
  53     _refs = ["IntervalSchedule"]
  54     _many_refs = []
  55
  56     def getIntervalSchedule(self):
  57         """A RegularTimePoint belongs to a RegularIntervalSchedule.
  58         """
  59         return self._IntervalSchedule
  60
  61     def setIntervalSchedule(self, value):
  62         if self._IntervalSchedule is not None:
  63             filtered = [x for x in self.IntervalSchedule.TimePoints if x != self]
  64             self._IntervalSchedule._TimePoints = filtered
  65
  66         self._IntervalSchedule = value
  67         if self._IntervalSchedule is not None:
  68             if self not in self._IntervalSchedule._TimePoints:
  69                 self._IntervalSchedule._TimePoints.append(self)
  70
  71     IntervalSchedule = property(getIntervalSchedule, setIntervalSchedule)
  72