CIM14/CPSM/Equipment/LoadModel/ConformLoadSchedule.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.SeasonDayTypeSchedule import SeasonDayTypeSchedule
  22
  23 class ConformLoadSchedule(SeasonDayTypeSchedule):
  24     """A curve of load  versus time (X-axis) showing the active power values (Y1-axis) and reactive power (Y2-axis) for each unit of the period covered. This curve represents a typical pattern of load over the time period for a given day type and season.-  Because value1 will always be specified in MW and value2 will always be specified in MVAr, the value1Multiplier and value2Multiplier attributes do not need to be specified.
  25     """
  26
  27     def __init__(self, ConformLoadGroup=None, *args, **kw_args):
  28         """Initialises a new 'ConformLoadSchedule' instance.
  29
  30         @param ConformLoadGroup: The ConformLoadGroup where the ConformLoadSchedule belongs.
  31         """
  32         self._ConformLoadGroup = None
  33         self.ConformLoadGroup = ConformLoadGroup
  34
  35         super(ConformLoadSchedule, self).__init__(*args, **kw_args)
  36
  37     _attrs = []
  38     _attr_types = {}
  39     _defaults = {}
  40     _enums = {}
  41     _refs = ["ConformLoadGroup"]
  42     _many_refs = []
  43
  44     def getConformLoadGroup(self):
  45         """The ConformLoadGroup where the ConformLoadSchedule belongs.
  46         """
  47         return self._ConformLoadGroup
  48
  49     def setConformLoadGroup(self, value):
  50         if self._ConformLoadGroup is not None:
  51             filtered = [x for x in self.ConformLoadGroup.ConformLoadSchedules if x != self]
  52             self._ConformLoadGroup._ConformLoadSchedules = filtered
  53
  54         self._ConformLoadGroup = value
  55         if self._ConformLoadGroup is not None:
  56             if self not in self._ConformLoadGroup._ConformLoadSchedules:
  57                 self._ConformLoadGroup._ConformLoadSchedules.append(self)
  58
  59     ConformLoadGroup = property(getConformLoadGroup, setConformLoadGroup)
  60