CIM14/IEC61970/Core/ConnectivityNodeContainer.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.IEC61970.Core.PowerSystemResource import PowerSystemResource
  22
  23 class ConnectivityNodeContainer(PowerSystemResource):
  24     """A base class for all objects that may contain ConnectivityNodes or TopologicalNodes.
  25     """
  26
  27     def __init__(self, ConnectivityNodes=None, TopologicalNode=None, *args, **kw_args):
  28         """Initialises a new 'ConnectivityNodeContainer' instance.
  29
  30         @param ConnectivityNodes: Connectivity nodes contained by this container.
  31         @param TopologicalNode: The topological nodes which belong to this connectivity node container.
  32         """
  33         self._ConnectivityNodes = []
  34         self.ConnectivityNodes = [] if ConnectivityNodes is None else ConnectivityNodes
  35
  36         self._TopologicalNode = []
  37         self.TopologicalNode = [] if TopologicalNode is None else TopologicalNode
  38
  39         super(ConnectivityNodeContainer, self).__init__(*args, **kw_args)
  40
  41     _attrs = []
  42     _attr_types = {}
  43     _defaults = {}
  44     _enums = {}
  45     _refs = ["ConnectivityNodes", "TopologicalNode"]
  46     _many_refs = ["ConnectivityNodes", "TopologicalNode"]
  47
  48     def getConnectivityNodes(self):
  49         """Connectivity nodes contained by this container.
  50         """
  51         return self._ConnectivityNodes
  52
  53     def setConnectivityNodes(self, value):
  54         for x in self._ConnectivityNodes:
  55             x.ConnectivityNodeContainer = None
  56         for y in value:
  57             y._ConnectivityNodeContainer = self
  58         self._ConnectivityNodes = value
  59
  60     ConnectivityNodes = property(getConnectivityNodes, setConnectivityNodes)
  61
  62     def addConnectivityNodes(self, *ConnectivityNodes):
  63         for obj in ConnectivityNodes:
  64             obj.ConnectivityNodeContainer = self
  65
  66     def removeConnectivityNodes(self, *ConnectivityNodes):
  67         for obj in ConnectivityNodes:
  68             obj.ConnectivityNodeContainer = None
  69
  70     def getTopologicalNode(self):
  71         """The topological nodes which belong to this connectivity node container.
  72         """
  73         return self._TopologicalNode
  74
  75     def setTopologicalNode(self, value):
  76         for x in self._TopologicalNode:
  77             x.ConnectivityNodeContainer = None
  78         for y in value:
  79             y._ConnectivityNodeContainer = self
  80         self._TopologicalNode = value
  81
  82     TopologicalNode = property(getTopologicalNode, setTopologicalNode)
  83
  84     def addTopologicalNode(self, *TopologicalNode):
  85         for obj in TopologicalNode:
  86             obj.ConnectivityNodeContainer = self
  87
  88     def removeTopologicalNode(self, *TopologicalNode):
  89         for obj in TopologicalNode:
  90             obj.ConnectivityNodeContainer = None
  91