CIM14/CPSM/Equipment/OperationalLimits/OperationalLimitSet.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 OperationalLimitSet(IdentifiedObject):
  24     """A set of limits associated with equipmnet.  Sets of limits might apply to a specific temperature, or season for example. A set of limits may contain may different severities of limit levels that would apply to the same equipment.   The set may contain limits of different types such as apparent power and current limits or high and low voltage limits  that are logically applied together as a set.
  25     """
  26
  27     def __init__(self, Terminal=None, Equipment=None, OperationalLimitValue=None, *args, **kw_args):
  28         """Initialises a new 'OperationalLimitSet' instance.
  29
  30         @param Terminal: The terminal specifically associated to this operational limit set.  If no terminal is associated, all terminals of the equipment are implied.
  31         @param Equipment: The equpment to which the limit set applies.
  32         @param OperationalLimitValue: Values of equipment limits.
  33         """
  34         self._Terminal = None
  35         self.Terminal = Terminal
  36
  37         self._Equipment = None
  38         self.Equipment = Equipment
  39
  40         self._OperationalLimitValue = []
  41         self.OperationalLimitValue = [] if OperationalLimitValue is None else OperationalLimitValue
  42
  43         super(OperationalLimitSet, self).__init__(*args, **kw_args)
  44
  45     _attrs = []
  46     _attr_types = {}
  47     _defaults = {}
  48     _enums = {}
  49     _refs = ["Terminal", "Equipment", "OperationalLimitValue"]
  50     _many_refs = ["OperationalLimitValue"]
  51
  52     def getTerminal(self):
  53         """The terminal specifically associated to this operational limit set.  If no terminal is associated, all terminals of the equipment are implied.
  54         """
  55         return self._Terminal
  56
  57     def setTerminal(self, value):
  58         if self._Terminal is not None:
  59             filtered = [x for x in self.Terminal.OperationalLimitSet if x != self]
  60             self._Terminal._OperationalLimitSet = filtered
  61
  62         self._Terminal = value
  63         if self._Terminal is not None:
  64             if self not in self._Terminal._OperationalLimitSet:
  65                 self._Terminal._OperationalLimitSet.append(self)
  66
  67     Terminal = property(getTerminal, setTerminal)
  68
  69     def getEquipment(self):
  70         """The equpment to which the limit set applies.
  71         """
  72         return self._Equipment
  73
  74     def setEquipment(self, value):
  75         if self._Equipment is not None:
  76             filtered = [x for x in self.Equipment.OperationalLimitSet if x != self]
  77             self._Equipment._OperationalLimitSet = filtered
  78
  79         self._Equipment = value
  80         if self._Equipment is not None:
  81             if self not in self._Equipment._OperationalLimitSet:
  82                 self._Equipment._OperationalLimitSet.append(self)
  83
  84     Equipment = property(getEquipment, setEquipment)
  85
  86     def getOperationalLimitValue(self):
  87         """Values of equipment limits.
  88         """
  89         return self._OperationalLimitValue
  90
  91     def setOperationalLimitValue(self, value):
  92         for x in self._OperationalLimitValue:
  93             x.OperationalLimitSet = None
  94         for y in value:
  95             y._OperationalLimitSet = self
  96         self._OperationalLimitValue = value
  97
  98     OperationalLimitValue = property(getOperationalLimitValue, setOperationalLimitValue)
  99
 100     def addOperationalLimitValue(self, *OperationalLimitValue):
 101         for obj in OperationalLimitValue:
 102             obj.OperationalLimitSet = self
 103
 104     def removeOperationalLimitValue(self, *OperationalLimitValue):
 105         for obj in OperationalLimitValue:
 106             obj.OperationalLimitSet = None
 107