CIM14/IEC61970/LoadModel/SubLoadArea.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.LoadModel.EnergyArea import EnergyArea
  22
  23 class SubLoadArea(EnergyArea):
  24     """The class is the second level in a hierarchical structure for grouping of loads for the purpose of load flow load scaling.
  25     """
  26
  27     def __init__(self, LoadGroups=None, LoadArea=None, *args, **kw_args):
  28         """Initialises a new 'SubLoadArea' instance.
  29
  30         @param LoadGroups: The Loadgroups in the SubLoadArea.
  31         @param LoadArea: The LoadArea where the SubLoadArea belongs.
  32         """
  33         self._LoadGroups = []
  34         self.LoadGroups = [] if LoadGroups is None else LoadGroups
  35
  36         self._LoadArea = None
  37         self.LoadArea = LoadArea
  38
  39         super(SubLoadArea, self).__init__(*args, **kw_args)
  40
  41     _attrs = []
  42     _attr_types = {}
  43     _defaults = {}
  44     _enums = {}
  45     _refs = ["LoadGroups", "LoadArea"]
  46     _many_refs = ["LoadGroups"]
  47
  48     def getLoadGroups(self):
  49         """The Loadgroups in the SubLoadArea.
  50         """
  51         return self._LoadGroups
  52
  53     def setLoadGroups(self, value):
  54         for x in self._LoadGroups:
  55             x.SubLoadArea = None
  56         for y in value:
  57             y._SubLoadArea = self
  58         self._LoadGroups = value
  59
  60     LoadGroups = property(getLoadGroups, setLoadGroups)
  61
  62     def addLoadGroups(self, *LoadGroups):
  63         for obj in LoadGroups:
  64             obj.SubLoadArea = self
  65
  66     def removeLoadGroups(self, *LoadGroups):
  67         for obj in LoadGroups:
  68             obj.SubLoadArea = None
  69
  70     def getLoadArea(self):
  71         """The LoadArea where the SubLoadArea belongs.
  72         """
  73         return self._LoadArea
  74
  75     def setLoadArea(self, value):
  76         if self._LoadArea is not None:
  77             filtered = [x for x in self.LoadArea.SubLoadAreas if x != self]
  78             self._LoadArea._SubLoadAreas = filtered
  79
  80         self._LoadArea = value
  81         if self._LoadArea is not None:
  82             if self not in self._LoadArea._SubLoadAreas:
  83                 self._LoadArea._SubLoadAreas.append(self)
  84
  85     LoadArea = property(getLoadArea, setLoadArea)
  86