CIM14/CPSM/Equipment/OperationalLimits/OperationalLimit.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.CPSM.Equipment.Core.IdentifiedObject import IdentifiedObject
  22
  23 class OperationalLimit(IdentifiedObject):
  24     """A value associated with a specific kind of limit.
  25     """
  26
  27     def __init__(self, type='', OperationalLimitSet=None, *args, **kw_args):
  28         """Initialises a new 'OperationalLimit' instance.
  29
  30         @param type: Used to specify high/low and limit levels.
  31         @param OperationalLimitSet: The limit set to which the limit values belong.
  32         """
  33         #: Used to specify high/low and limit levels.
  34         self.type = type
  35
  36         self._OperationalLimitSet = None
  37         self.OperationalLimitSet = OperationalLimitSet
  38
  39         super(OperationalLimit, self).__init__(*args, **kw_args)
  40
  41     _attrs = ["type"]
  42     _attr_types = {"type": str}
  43     _defaults = {"type": ''}
  44     _enums = {}
  45     _refs = ["OperationalLimitSet"]
  46     _many_refs = []
  47
  48     def getOperationalLimitSet(self):
  49         """The limit set to which the limit values belong.
  50         """
  51         return self._OperationalLimitSet
  52
  53     def setOperationalLimitSet(self, value):
  54         if self._OperationalLimitSet is not None:
  55             filtered = [x for x in self.OperationalLimitSet.OperationalLimitValue if x != self]
  56             self._OperationalLimitSet._OperationalLimitValue = filtered
  57
  58         self._OperationalLimitSet = value
  59         if self._OperationalLimitSet is not None:
  60             if self not in self._OperationalLimitSet._OperationalLimitValue:
  61                 self._OperationalLimitSet._OperationalLimitValue.append(self)
  62
  63     OperationalLimitSet = property(getOperationalLimitSet, setOperationalLimitSet)
  64