CIM14/ENTSOE/Equipment/Core/Substation.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.Core.EquipmentContainer import EquipmentContainer
  22
  23 class Substation(EquipmentContainer):
  24     """A collection of equipment for purposes other than generation or utilization, through which electric energy in bulk is passed for the purposes of switching or modifying its characteristics.
  25     """
  26
  27     def __init__(self, Region=None, VoltageLevels=None, *args, **kw_args):
  28         """Initialises a new 'Substation' instance.
  29
  30         @param Region: The association is used in the naming hierarchy.
  31         @param VoltageLevels: The association is used in the naming hierarchy.
  32         """
  33         self._Region = None
  34         self.Region = Region
  35
  36         self._VoltageLevels = []
  37         self.VoltageLevels = [] if VoltageLevels is None else VoltageLevels
  38
  39         super(Substation, self).__init__(*args, **kw_args)
  40
  41     _attrs = []
  42     _attr_types = {}
  43     _defaults = {}
  44     _enums = {}
  45     _refs = ["Region", "VoltageLevels"]
  46     _many_refs = ["VoltageLevels"]
  47
  48     def getRegion(self):
  49         """The association is used in the naming hierarchy.
  50         """
  51         return self._Region
  52
  53     def setRegion(self, value):
  54         if self._Region is not None:
  55             filtered = [x for x in self.Region.Substations if x != self]
  56             self._Region._Substations = filtered
  57
  58         self._Region = value
  59         if self._Region is not None:
  60             if self not in self._Region._Substations:
  61                 self._Region._Substations.append(self)
  62
  63     Region = property(getRegion, setRegion)
  64
  65     def getVoltageLevels(self):
  66         """The association is used in the naming hierarchy.
  67         """
  68         return self._VoltageLevels
  69
  70     def setVoltageLevels(self, value):
  71         for x in self._VoltageLevels:
  72             x.Substation = None
  73         for y in value:
  74             y._Substation = self
  75         self._VoltageLevels = value
  76
  77     VoltageLevels = property(getVoltageLevels, setVoltageLevels)
  78
  79     def addVoltageLevels(self, *VoltageLevels):
  80         for obj in VoltageLevels:
  81             obj.Substation = self
  82
  83     def removeVoltageLevels(self, *VoltageLevels):
  84         for obj in VoltageLevels:
  85             obj.Substation = None
  86