CIM14/CPSM/Equipment/Core/ConnectivityNode.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 ConnectivityNode(IdentifiedObject):
  24     """Connectivity nodes are points where terminals of conducting equipment are connected together with zero impedance.- [R3.2] is - satisfied by navigation to SubControlArea. - [R3.3] is satisfied by navigation to BaseVoltage. - [R3.5] is satisfied by navigation to VoltageLevel - By convention, ConnectivityNodes may only be placed within VoltageLevels.
  25     """
  26
  27     def __init__(self, Terminals=None, ConnectivityNodeContainer=None, *args, **kw_args):
  28         """Initialises a new 'ConnectivityNode' instance.
  29
  30         @param Terminals: Terminals interconnect with zero impedance at a node.  Measurements on a node apply to all of its terminals.
  31         @param ConnectivityNodeContainer: Container of this connectivity node.
  32         """
  33         self._Terminals = []
  34         self.Terminals = [] if Terminals is None else Terminals
  35
  36         self._ConnectivityNodeContainer = None
  37         self.ConnectivityNodeContainer = ConnectivityNodeContainer
  38
  39         super(ConnectivityNode, self).__init__(*args, **kw_args)
  40
  41     _attrs = []
  42     _attr_types = {}
  43     _defaults = {}
  44     _enums = {}
  45     _refs = ["Terminals", "ConnectivityNodeContainer"]
  46     _many_refs = ["Terminals"]
  47
  48     def getTerminals(self):
  49         """Terminals interconnect with zero impedance at a node.  Measurements on a node apply to all of its terminals.
  50         """
  51         return self._Terminals
  52
  53     def setTerminals(self, value):
  54         for x in self._Terminals:
  55             x.ConnectivityNode = None
  56         for y in value:
  57             y._ConnectivityNode = self
  58         self._Terminals = value
  59
  60     Terminals = property(getTerminals, setTerminals)
  61
  62     def addTerminals(self, *Terminals):
  63         for obj in Terminals:
  64             obj.ConnectivityNode = self
  65
  66     def removeTerminals(self, *Terminals):
  67         for obj in Terminals:
  68             obj.ConnectivityNode = None
  69
  70     def getConnectivityNodeContainer(self):
  71         """Container of this connectivity node.
  72         """
  73         return self._ConnectivityNodeContainer
  74
  75     def setConnectivityNodeContainer(self, value):
  76         if self._ConnectivityNodeContainer is not None:
  77             filtered = [x for x in self.ConnectivityNodeContainer.ConnectivityNodes if x != self]
  78             self._ConnectivityNodeContainer._ConnectivityNodes = filtered
  79
  80         self._ConnectivityNodeContainer = value
  81         if self._ConnectivityNodeContainer is not None:
  82             if self not in self._ConnectivityNodeContainer._ConnectivityNodes:
  83                 self._ConnectivityNodeContainer._ConnectivityNodes.append(self)
  84
  85     ConnectivityNodeContainer = property(getConnectivityNodeContainer, setConnectivityNodeContainer)
  86