CIM14/IEC61970/Meas/AccumulatorValue.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.Meas.MeasurementValue import MeasurementValue
  22
  23 class AccumulatorValue(MeasurementValue):
  24     """AccumulatorValue represents a accumulated (counted) MeasurementValue.
  25     """
  26
  27     def __init__(self, value=0, Accumulator=None, *args, **kw_args):
  28         """Initialises a new 'AccumulatorValue' instance.
  29
  30         @param value: The value to supervise. The value is positive.
  31         @param Accumulator: Measurement to which this value is connected.
  32         """
  33         #: The value to supervise. The value is positive.
  34         self.value = value
  35
  36         self._Accumulator = None
  37         self.Accumulator = Accumulator
  38
  39         super(AccumulatorValue, self).__init__(*args, **kw_args)
  40
  41     _attrs = ["value"]
  42     _attr_types = {"value": int}
  43     _defaults = {"value": 0}
  44     _enums = {}
  45     _refs = ["Accumulator"]
  46     _many_refs = []
  47
  48     def getAccumulator(self):
  49         """Measurement to which this value is connected.
  50         """
  51         return self._Accumulator
  52
  53     def setAccumulator(self, value):
  54         if self._Accumulator is not None:
  55             filtered = [x for x in self.Accumulator.AccumulatorValues if x != self]
  56             self._Accumulator._AccumulatorValues = filtered
  57
  58         self._Accumulator = value
  59         if self._Accumulator is not None:
  60             if self not in self._Accumulator._AccumulatorValues:
  61                 self._Accumulator._AccumulatorValues.append(self)
  62
  63     Accumulator = property(getAccumulator, setAccumulator)
  64