CIM14/ENTSOE/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.ENTSOE.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='', OperationalLimitType=None, 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 OperationalLimitType: The limit type associated with this limit.
  32         @param OperationalLimitSet: The limit set to which the limit values belong.
  33         """
  34         #: Used to specify high/low and limit levels.
  35         self.type = type
  36
  37         self._OperationalLimitType = None
  38         self.OperationalLimitType = OperationalLimitType
  39
  40         self._OperationalLimitSet = None
  41         self.OperationalLimitSet = OperationalLimitSet
  42
  43         super(OperationalLimit, self).__init__(*args, **kw_args)
  44
  45     _attrs = ["type"]
  46     _attr_types = {"type": str}
  47     _defaults = {"type": ''}
  48     _enums = {}
  49     _refs = ["OperationalLimitType", "OperationalLimitSet"]
  50     _many_refs = []
  51
  52     def getOperationalLimitType(self):
  53         """The limit type associated with this limit.
  54         """
  55         return self._OperationalLimitType
  56
  57     def setOperationalLimitType(self, value):
  58         if self._OperationalLimitType is not None:
  59             filtered = [x for x in self.OperationalLimitType.OperationalLimit if x != self]
  60             self._OperationalLimitType._OperationalLimit = filtered
  61
  62         self._OperationalLimitType = value
  63         if self._OperationalLimitType is not None:
  64             if self not in self._OperationalLimitType._OperationalLimit:
  65                 self._OperationalLimitType._OperationalLimit.append(self)
  66
  67     OperationalLimitType = property(getOperationalLimitType, setOperationalLimitType)
  68
  69     def getOperationalLimitSet(self):
  70         """The limit set to which the limit values belong.
  71         """
  72         return self._OperationalLimitSet
  73
  74     def setOperationalLimitSet(self, value):
  75         if self._OperationalLimitSet is not None:
  76             filtered = [x for x in self.OperationalLimitSet.OperationalLimitValue if x != self]
  77             self._OperationalLimitSet._OperationalLimitValue = filtered
  78
  79         self._OperationalLimitSet = value
  80         if self._OperationalLimitSet is not None:
  81             if self not in self._OperationalLimitSet._OperationalLimitValue:
  82                 self._OperationalLimitSet._OperationalLimitValue.append(self)
  83
  84     OperationalLimitSet = property(getOperationalLimitSet, setOperationalLimitSet)
  85