CIM14/IEC61970/Generation/Production/IncrementalHeatRateCurve.py

   1 # Copyright (C) 2010 Richard Lincoln
   2 #
   3 # This library is free software; you can redistribute it and/or
   4 # modify it under the terms of the GNU Lesser General Public
   5 # License as published by the Free Software Foundation; either
   6 # version 2.1 of the License, or (at your option) any later version.
   7 #
   8 # This library is distributed in the hope that it will be useful,
   9 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  10 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  11 # Lesser General Public License for more details.
  12 #
  13 # You should have received a copy of the GNU Lesser General Public
  14 # License along with this library; if not, write to the Free Software
  15 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA, USA
  16
  17 from CIM14.IEC61970.Core.Curve import Curve
  18
  19 class IncrementalHeatRateCurve(Curve):
  20     """Relationship between unit incremental heat rate in (delta energy/time) per (delta active power) and unit output in active power. The IHR curve represents the slope of the HeatInputCurve. Note that the 'incremental heat rate' and the 'heat rate' have the same engineering units.
  21     """
  22
  23     def __init__(self, isNetGrossP=False, ThermalGeneratingUnit=None, *args, **kw_args):
  24         """Initialises a new 'IncrementalHeatRateCurve' instance.
  25
  26         @param isNetGrossP: Flag is set to true when output is expressed in net active power
  27         @param ThermalGeneratingUnit: A thermal generating unit may have an incremental heat rate curve
  28         """
  29         #: Flag is set to true when output is expressed in net active power
  30         self.isNetGrossP = isNetGrossP
  31
  32         self._ThermalGeneratingUnit = None
  33         self.ThermalGeneratingUnit = ThermalGeneratingUnit
  34
  35         super(IncrementalHeatRateCurve, self).__init__(*args, **kw_args)
  36
  37     _attrs = ["isNetGrossP"]
  38     _attr_types = {"isNetGrossP": bool}
  39     _defaults = {"isNetGrossP": False}
  40     _enums = {}
  41     _refs = ["ThermalGeneratingUnit"]
  42     _many_refs = []
  43
  44     def getThermalGeneratingUnit(self):
  45         """A thermal generating unit may have an incremental heat rate curve
  46         """
  47         return self._ThermalGeneratingUnit
  48
  49     def setThermalGeneratingUnit(self, value):
  50         if self._ThermalGeneratingUnit is not None:
  51             self._ThermalGeneratingUnit._IncrementalHeatRateCurve = None
  52
  53         self._ThermalGeneratingUnit = value
  54         if self._ThermalGeneratingUnit is not None:
  55             self._ThermalGeneratingUnit._IncrementalHeatRateCurve = self
  56
  57     ThermalGeneratingUnit = property(getThermalGeneratingUnit, setThermalGeneratingUnit)
  58