CIM14/IEC61970/Equivalents/EquivalentEquipment.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.ConductingEquipment import ConductingEquipment
  22
  23 class EquivalentEquipment(ConductingEquipment):
  24     """The class represents equivalent objects that are the result of a network reduction. The class is the base for equivalent objects of different types.
  25     """
  26
  27     def __init__(self, EquivalentNetwork=None, *args, **kw_args):
  28         """Initialises a new 'EquivalentEquipment' instance.
  29
  30         @param EquivalentNetwork: The equivalent where the reduced model belongs.
  31         """
  32         self._EquivalentNetwork = None
  33         self.EquivalentNetwork = EquivalentNetwork
  34
  35         super(EquivalentEquipment, self).__init__(*args, **kw_args)
  36
  37     _attrs = []
  38     _attr_types = {}
  39     _defaults = {}
  40     _enums = {}
  41     _refs = ["EquivalentNetwork"]
  42     _many_refs = []
  43
  44     def getEquivalentNetwork(self):
  45         """The equivalent where the reduced model belongs.
  46         """
  47         return self._EquivalentNetwork
  48
  49     def setEquivalentNetwork(self, value):
  50         if self._EquivalentNetwork is not None:
  51             filtered = [x for x in self.EquivalentNetwork.EquivalentEquipments if x != self]
  52             self._EquivalentNetwork._EquivalentEquipments = filtered
  53
  54         self._EquivalentNetwork = value
  55         if self._EquivalentNetwork is not None:
  56             if self not in self._EquivalentNetwork._EquivalentEquipments:
  57                 self._EquivalentNetwork._EquivalentEquipments.append(self)
  58
  59     EquivalentNetwork = property(getEquivalentNetwork, setEquivalentNetwork)
  60