CIM14/CPSM/Equipment/LoadModel/ConformLoadGroup.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.LoadGroup import LoadGroup
  22
  23 class ConformLoadGroup(LoadGroup):
  24     """A group of loads conforming to an allocation pattern.
  25     """
  26
  27     def __init__(self, EnergyConsumers=None, ConformLoadSchedules=None, *args, **kw_args):
  28         """Initialises a new 'ConformLoadGroup' instance.
  29
  30         @param EnergyConsumers: Conform loads assigned to this ConformLoadGroup.
  31         @param ConformLoadSchedules: The ConformLoadSchedules in the ConformLoadGroup.
  32         """
  33         self._EnergyConsumers = []
  34         self.EnergyConsumers = [] if EnergyConsumers is None else EnergyConsumers
  35
  36         self._ConformLoadSchedules = []
  37         self.ConformLoadSchedules = [] if ConformLoadSchedules is None else ConformLoadSchedules
  38
  39         super(ConformLoadGroup, self).__init__(*args, **kw_args)
  40
  41     _attrs = []
  42     _attr_types = {}
  43     _defaults = {}
  44     _enums = {}
  45     _refs = ["EnergyConsumers", "ConformLoadSchedules"]
  46     _many_refs = ["EnergyConsumers", "ConformLoadSchedules"]
  47
  48     def getEnergyConsumers(self):
  49         """Conform loads assigned to this ConformLoadGroup.
  50         """
  51         return self._EnergyConsumers
  52
  53     def setEnergyConsumers(self, value):
  54         for x in self._EnergyConsumers:
  55             x.LoadGroup = None
  56         for y in value:
  57             y._LoadGroup = self
  58         self._EnergyConsumers = value
  59
  60     EnergyConsumers = property(getEnergyConsumers, setEnergyConsumers)
  61
  62     def addEnergyConsumers(self, *EnergyConsumers):
  63         for obj in EnergyConsumers:
  64             obj.LoadGroup = self
  65
  66     def removeEnergyConsumers(self, *EnergyConsumers):
  67         for obj in EnergyConsumers:
  68             obj.LoadGroup = None
  69
  70     def getConformLoadSchedules(self):
  71         """The ConformLoadSchedules in the ConformLoadGroup.
  72         """
  73         return self._ConformLoadSchedules
  74
  75     def setConformLoadSchedules(self, value):
  76         for x in self._ConformLoadSchedules:
  77             x.ConformLoadGroup = None
  78         for y in value:
  79             y._ConformLoadGroup = self
  80         self._ConformLoadSchedules = value
  81
  82     ConformLoadSchedules = property(getConformLoadSchedules, setConformLoadSchedules)
  83
  84     def addConformLoadSchedules(self, *ConformLoadSchedules):
  85         for obj in ConformLoadSchedules:
  86             obj.ConformLoadGroup = self
  87
  88     def removeConformLoadSchedules(self, *ConformLoadSchedules):
  89         for obj in ConformLoadSchedules:
  90             obj.ConformLoadGroup = None
  91