CIM14/CPSM/Equipment/LoadModel/NonConformLoadSchedule.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 NonConformLoadSchedule(SeasonDayTypeSchedule):
  24     """An active power (Y1-axis) and reactive power (Y2-axis) schedule (curves) versus time (X-axis) for non-conforming loads, e.g., large industrial load or power station service (where modeled)-  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, NonConformLoadGroup=None, *args, **kw_args):
  28         """Initialises a new 'NonConformLoadSchedule' instance.
  29
  30         @param NonConformLoadGroup: The NonConformLoadGroup where the NonConformLoadSchedule belongs.
  31         """
  32         self._NonConformLoadGroup = None
  33         self.NonConformLoadGroup = NonConformLoadGroup
  34
  35         super(NonConformLoadSchedule, self).__init__(*args, **kw_args)
  36
  37     _attrs = []
  38     _attr_types = {}
  39     _defaults = {}
  40     _enums = {}
  41     _refs = ["NonConformLoadGroup"]
  42     _many_refs = []
  43
  44     def getNonConformLoadGroup(self):
  45         """The NonConformLoadGroup where the NonConformLoadSchedule belongs.
  46         """
  47         return self._NonConformLoadGroup
  48
  49     def setNonConformLoadGroup(self, value):
  50         if self._NonConformLoadGroup is not None:
  51             filtered = [x for x in self.NonConformLoadGroup.NonConformLoadSchedules if x != self]
  52             self._NonConformLoadGroup._NonConformLoadSchedules = filtered
  53
  54         self._NonConformLoadGroup = value
  55         if self._NonConformLoadGroup is not None:
  56             if self not in self._NonConformLoadGroup._NonConformLoadSchedules:
  57                 self._NonConformLoadGroup._NonConformLoadSchedules.append(self)
  58
  59     NonConformLoadGroup = property(getNonConformLoadGroup, setNonConformLoadGroup)
  60