CIM14/IEC61970/Core/SubGeographicalRegion.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.IdentifiedObject import IdentifiedObject
  22
  23 class SubGeographicalRegion(IdentifiedObject):
  24     """A subset of a geographical region of a power system network model.
  25     """
  26
  27     def __init__(self, Region=None, Substations=None, Lines=None, *args, **kw_args):
  28         """Initialises a new 'SubGeographicalRegion' instance.
  29
  30         @param Region: The association is used in the naming hierarchy.
  31         @param Substations: The association is used in the naming hierarchy.
  32         @param Lines: A Line can be contained by a SubGeographical Region.
  33         """
  34         self._Region = None
  35         self.Region = Region
  36
  37         self._Substations = []
  38         self.Substations = [] if Substations is None else Substations
  39
  40         self._Lines = []
  41         self.Lines = [] if Lines is None else Lines
  42
  43         super(SubGeographicalRegion, self).__init__(*args, **kw_args)
  44
  45     _attrs = []
  46     _attr_types = {}
  47     _defaults = {}
  48     _enums = {}
  49     _refs = ["Region", "Substations", "Lines"]
  50     _many_refs = ["Substations", "Lines"]
  51
  52     def getRegion(self):
  53         """The association is used in the naming hierarchy.
  54         """
  55         return self._Region
  56
  57     def setRegion(self, value):
  58         if self._Region is not None:
  59             filtered = [x for x in self.Region.Regions if x != self]
  60             self._Region._Regions = filtered
  61
  62         self._Region = value
  63         if self._Region is not None:
  64             if self not in self._Region._Regions:
  65                 self._Region._Regions.append(self)
  66
  67     Region = property(getRegion, setRegion)
  68
  69     def getSubstations(self):
  70         """The association is used in the naming hierarchy.
  71         """
  72         return self._Substations
  73
  74     def setSubstations(self, value):
  75         for x in self._Substations:
  76             x.Region = None
  77         for y in value:
  78             y._Region = self
  79         self._Substations = value
  80
  81     Substations = property(getSubstations, setSubstations)
  82
  83     def addSubstations(self, *Substations):
  84         for obj in Substations:
  85             obj.Region = self
  86
  87     def removeSubstations(self, *Substations):
  88         for obj in Substations:
  89             obj.Region = None
  90
  91     def getLines(self):
  92         """A Line can be contained by a SubGeographical Region.
  93         """
  94         return self._Lines
  95
  96     def setLines(self, value):
  97         for x in self._Lines:
  98             x.Region = None
  99         for y in value:
 100             y._Region = self
 101         self._Lines = value
 102
 103     Lines = property(getLines, setLines)
 104
 105     def addLines(self, *Lines):
 106         for obj in Lines:
 107             obj.Region = self
 108
 109     def removeLines(self, *Lines):
 110         for obj in Lines:
 111             obj.Region = None
 112