CIM14/IEC61970/Generation/Production/IncrementalHeatRateCurve.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.IEC61970.Core.Curve import Curve
  22
  23 class IncrementalHeatRateCurve(Curve):
  24     """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.
  25     """
  26
  27     def __init__(self, isNetGrossP=False, ThermalGeneratingUnit=None, *args, **kw_args):
  28         """Initialises a new 'IncrementalHeatRateCurve' instance.
  29
  30         @param isNetGrossP: Flag is set to true when output is expressed in net active power
  31         @param ThermalGeneratingUnit: A thermal generating unit may have an incremental heat rate curve
  32         """
  33         #: Flag is set to true when output is expressed in net active power
  34         self.isNetGrossP = isNetGrossP
  35
  36         self._ThermalGeneratingUnit = None
  37         self.ThermalGeneratingUnit = ThermalGeneratingUnit
  38
  39         super(IncrementalHeatRateCurve, self).__init__(*args, **kw_args)
  40
  41     _attrs = ["isNetGrossP"]
  42     _attr_types = {"isNetGrossP": bool}
  43     _defaults = {"isNetGrossP": False}
  44     _enums = {}
  45     _refs = ["ThermalGeneratingUnit"]
  46     _many_refs = []
  47
  48     def getThermalGeneratingUnit(self):
  49         """A thermal generating unit may have an incremental heat rate curve
  50         """
  51         return self._ThermalGeneratingUnit
  52
  53     def setThermalGeneratingUnit(self, value):
  54         if self._ThermalGeneratingUnit is not None:
  55             self._ThermalGeneratingUnit._IncrementalHeatRateCurve = None
  56
  57         self._ThermalGeneratingUnit = value
  58         if self._ThermalGeneratingUnit is not None:
  59             self._ThermalGeneratingUnit.IncrementalHeatRateCurve = None
  60             self._ThermalGeneratingUnit._IncrementalHeatRateCurve = self
  61
  62     ThermalGeneratingUnit = property(getThermalGeneratingUnit, setThermalGeneratingUnit)
  63