CIM14/CPSM/Equipment/LoadModel/ConformLoad.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.Wires.EnergyConsumer import EnergyConsumer
  22
  23 class ConformLoad(EnergyConsumer):
  24     """ConformLoad represent loads that follow a daily load change pattern where the pattern can be used to scale the load with a system load.-  [R8.2] is satisfied by navigation to ConnectivityNode and Substation -  The definition of the real and reactive power injections for an EnergyConsumer can be done using different sets of attributes.  In the simplest case, the injections can be defined directly using only the attributes “pfixed” and “qfixed”. -  The injections for a ConformLoad can be defined as a percentage of the ConformLoadGroup with the attributes “pfixedPct” and “qfixedPct”.  In this case, the associated ConformLoadGroup would have to have an associated ConformLoadSchedule. -  See EnergyConsumer for specific notes about inherited attributes.
  25     """
  26
  27     def __init__(self, LoadGroup=None, *args, **kw_args):
  28         """Initialises a new 'ConformLoad' instance.
  29
  30         @param LoadGroup: Group of this ConformLoad.
  31         """
  32         self._LoadGroup = None
  33         self.LoadGroup = LoadGroup
  34
  35         super(ConformLoad, self).__init__(*args, **kw_args)
  36
  37     _attrs = []
  38     _attr_types = {}
  39     _defaults = {}
  40     _enums = {}
  41     _refs = ["LoadGroup"]
  42     _many_refs = []
  43
  44     def getLoadGroup(self):
  45         """Group of this ConformLoad.
  46         """
  47         return self._LoadGroup
  48
  49     def setLoadGroup(self, value):
  50         if self._LoadGroup is not None:
  51             filtered = [x for x in self.LoadGroup.EnergyConsumers if x != self]
  52             self._LoadGroup._EnergyConsumers = filtered
  53
  54         self._LoadGroup = value
  55         if self._LoadGroup is not None:
  56             if self not in self._LoadGroup._EnergyConsumers:
  57                 self._LoadGroup._EnergyConsumers.append(self)
  58
  59     LoadGroup = property(getLoadGroup, setLoadGroup)
  60