CIM14/ENTSOE/Equipment/ControlArea/TieFlow.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.Element import Element
  22
  23 class TieFlow(Element):
  24     """A flow specification in terms of location and direction for a control area.
  25     """
  26
  27     def __init__(self, positiveFlowIn=False, ControlArea=None, Terminal=None, *args, **kw_args):
  28         """Initialises a new 'TieFlow' instance.
  29
  30         @param positiveFlowIn: The flow is positive into the terminal.  A flow is positive if it is an import into the control area.
  31         @param ControlArea: The control area of the tie flows.
  32         @param Terminal: The terminal to which this tie flow belongs.
  33         """
  34         #: The flow is positive into the terminal.  A flow is positive if it is an import into the control area.
  35         self.positiveFlowIn = positiveFlowIn
  36
  37         self._ControlArea = None
  38         self.ControlArea = ControlArea
  39
  40         self._Terminal = None
  41         self.Terminal = Terminal
  42
  43         super(TieFlow, self).__init__(*args, **kw_args)
  44
  45     _attrs = ["positiveFlowIn"]
  46     _attr_types = {"positiveFlowIn": bool}
  47     _defaults = {"positiveFlowIn": False}
  48     _enums = {}
  49     _refs = ["ControlArea", "Terminal"]
  50     _many_refs = []
  51
  52     def getControlArea(self):
  53         """The control area of the tie flows.
  54         """
  55         return self._ControlArea
  56
  57     def setControlArea(self, value):
  58         if self._ControlArea is not None:
  59             filtered = [x for x in self.ControlArea.TieFlow if x != self]
  60             self._ControlArea._TieFlow = filtered
  61
  62         self._ControlArea = value
  63         if self._ControlArea is not None:
  64             if self not in self._ControlArea._TieFlow:
  65                 self._ControlArea._TieFlow.append(self)
  66
  67     ControlArea = property(getControlArea, setControlArea)
  68
  69     def getTerminal(self):
  70         """The terminal to which this tie flow belongs.
  71         """
  72         return self._Terminal
  73
  74     def setTerminal(self, value):
  75         if self._Terminal is not None:
  76             filtered = [x for x in self.Terminal.TieFlow if x != self]
  77             self._Terminal._TieFlow = filtered
  78
  79         self._Terminal = value
  80         if self._Terminal is not None:
  81             if self not in self._Terminal._TieFlow:
  82                 self._Terminal._TieFlow.append(self)
  83
  84     Terminal = property(getTerminal, setTerminal)
  85