CIM14/IEC61970/Generation/Production/GenUnitOpCostCurve.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 GenUnitOpCostCurve(Curve):
  24     """Relationship between unit operating cost (Y-axis) and unit output active power (X-axis). The operating cost curve for thermal units is derived from heat input and fuel costs. The operating cost curve for hydro units is derived from water flow rates and equivalent water costs.
  25     """
  26
  27     def __init__(self, isNetGrossP=False, GeneratingUnit=None, *args, **kw_args):
  28         """Initialises a new 'GenUnitOpCostCurve' instance.
  29
  30         @param isNetGrossP: Flag is set to true when output is expressed in net active power
  31         @param GeneratingUnit: A generating unit may have one or more cost curves, depending upon fuel mixture and fuel cost.
  32         """
  33         #: Flag is set to true when output is expressed in net active power
  34         self.isNetGrossP = isNetGrossP
  35
  36         self._GeneratingUnit = None
  37         self.GeneratingUnit = GeneratingUnit
  38
  39         super(GenUnitOpCostCurve, self).__init__(*args, **kw_args)
  40
  41     _attrs = ["isNetGrossP"]
  42     _attr_types = {"isNetGrossP": bool}
  43     _defaults = {"isNetGrossP": False}
  44     _enums = {}
  45     _refs = ["GeneratingUnit"]
  46     _many_refs = []
  47
  48     def getGeneratingUnit(self):
  49         """A generating unit may have one or more cost curves, depending upon fuel mixture and fuel cost.
  50         """
  51         return self._GeneratingUnit
  52
  53     def setGeneratingUnit(self, value):
  54         if self._GeneratingUnit is not None:
  55             filtered = [x for x in self.GeneratingUnit.GenUnitOpCostCurves if x != self]
  56             self._GeneratingUnit._GenUnitOpCostCurves = filtered
  57
  58         self._GeneratingUnit = value
  59         if self._GeneratingUnit is not None:
  60             if self not in self._GeneratingUnit._GenUnitOpCostCurves:
  61                 self._GeneratingUnit._GenUnitOpCostCurves.append(self)
  62
  63     GeneratingUnit = property(getGeneratingUnit, setGeneratingUnit)
  64