CIM14/IEC61970/Equivalents/EquivalentNetwork.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.ConnectivityNodeContainer import ConnectivityNodeContainer
  22
  23 class EquivalentNetwork(ConnectivityNodeContainer):
  24     """A class that represents an external meshed network that has been reduced to an electrically equivalent model. The ConnectivityNodes contained in the equivalent are intended to reflect internal nodes of the equivalent. The boundary Connectivity nodes where the equivalent connects outside itself are NOT contained by the equivalent.
  25     """
  26
  27     def __init__(self, EquivalentEquipments=None, *args, **kw_args):
  28         """Initialises a new 'EquivalentNetwork' instance.
  29
  30         @param EquivalentEquipments: The associated reduced equivalents.
  31         """
  32         self._EquivalentEquipments = []
  33         self.EquivalentEquipments = [] if EquivalentEquipments is None else EquivalentEquipments
  34
  35         super(EquivalentNetwork, self).__init__(*args, **kw_args)
  36
  37     _attrs = []
  38     _attr_types = {}
  39     _defaults = {}
  40     _enums = {}
  41     _refs = ["EquivalentEquipments"]
  42     _many_refs = ["EquivalentEquipments"]
  43
  44     def getEquivalentEquipments(self):
  45         """The associated reduced equivalents.
  46         """
  47         return self._EquivalentEquipments
  48
  49     def setEquivalentEquipments(self, value):
  50         for x in self._EquivalentEquipments:
  51             x.EquivalentNetwork = None
  52         for y in value:
  53             y._EquivalentNetwork = self
  54         self._EquivalentEquipments = value
  55
  56     EquivalentEquipments = property(getEquivalentEquipments, setEquivalentEquipments)
  57
  58     def addEquivalentEquipments(self, *EquivalentEquipments):
  59         for obj in EquivalentEquipments:
  60             obj.EquivalentNetwork = self
  61
  62     def removeEquivalentEquipments(self, *EquivalentEquipments):
  63         for obj in EquivalentEquipments:
  64             obj.EquivalentNetwork = None
  65