CIM14/CPSM/Equipment/LoadModel/LoadArea.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.CPSM.Equipment.LoadModel.EnergyArea import EnergyArea
  22
  23 class LoadArea(EnergyArea):
  24     """The class is the root or first level in a hierarchical structure for grouping of loads for the purpose of load flow load scaling.
  25     """
  26
  27     def __init__(self, SubLoadAreas=None, *args, **kw_args):
  28         """Initialises a new 'LoadArea' instance.
  29
  30         @param SubLoadAreas: The SubLoadAreas in the LoadArea.
  31         """
  32         self._SubLoadAreas = []
  33         self.SubLoadAreas = [] if SubLoadAreas is None else SubLoadAreas
  34
  35         super(LoadArea, self).__init__(*args, **kw_args)
  36
  37     _attrs = []
  38     _attr_types = {}
  39     _defaults = {}
  40     _enums = {}
  41     _refs = ["SubLoadAreas"]
  42     _many_refs = ["SubLoadAreas"]
  43
  44     def getSubLoadAreas(self):
  45         """The SubLoadAreas in the LoadArea.
  46         """
  47         return self._SubLoadAreas
  48
  49     def setSubLoadAreas(self, value):
  50         for x in self._SubLoadAreas:
  51             x.LoadArea = None
  52         for y in value:
  53             y._LoadArea = self
  54         self._SubLoadAreas = value
  55
  56     SubLoadAreas = property(getSubLoadAreas, setSubLoadAreas)
  57
  58     def addSubLoadAreas(self, *SubLoadAreas):
  59         for obj in SubLoadAreas:
  60             obj.LoadArea = self
  61
  62     def removeSubLoadAreas(self, *SubLoadAreas):
  63         for obj in SubLoadAreas:
  64             obj.LoadArea = None
  65