Fixing website and API documentation links
[PyCIM.git] / CIM14 / IEC61970 / Generation / Production / CombinedCyclePlant.py
blobe078cd175141f515f02b3e2b452179e9d8282f77
1 # Copyright (C) 2010-2011 Richard Lincoln
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:
10 # The above copyright notice and this permission notice shall be included in
11 # all copies or substantial portions of the Software.
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.
21 from CIM14.IEC61970.Core.PowerSystemResource import PowerSystemResource
23 class CombinedCyclePlant(PowerSystemResource):
24 """A set of combustion turbines and steam turbines where the exhaust heat from the combustion turbines is recovered to make steam for the steam turbines, resulting in greater overall plant efficiency
25 """
27 def __init__(self, combCyclePlantRating=0.0, ThermalGeneratingUnits=None, *args, **kw_args):
28 """Initialises a new 'CombinedCyclePlant' instance.
30 @param combCyclePlantRating: The combined cycle plant's active power output rating
31 @param ThermalGeneratingUnits: A thermal generating unit may be a member of a combined cycle plant
32 """
33 #: The combined cycle plant's active power output rating
34 self.combCyclePlantRating = combCyclePlantRating
36 self._ThermalGeneratingUnits = []
37 self.ThermalGeneratingUnits = [] if ThermalGeneratingUnits is None else ThermalGeneratingUnits
39 super(CombinedCyclePlant, self).__init__(*args, **kw_args)
41 _attrs = ["combCyclePlantRating"]
42 _attr_types = {"combCyclePlantRating": float}
43 _defaults = {"combCyclePlantRating": 0.0}
44 _enums = {}
45 _refs = ["ThermalGeneratingUnits"]
46 _many_refs = ["ThermalGeneratingUnits"]
48 def getThermalGeneratingUnits(self):
49 """A thermal generating unit may be a member of a combined cycle plant
50 """
51 return self._ThermalGeneratingUnits
53 def setThermalGeneratingUnits(self, value):
54 for x in self._ThermalGeneratingUnits:
55 x.CombinedCyclePlant = None
56 for y in value:
57 y._CombinedCyclePlant = self
58 self._ThermalGeneratingUnits = value
60 ThermalGeneratingUnits = property(getThermalGeneratingUnits, setThermalGeneratingUnits)
62 def addThermalGeneratingUnits(self, *ThermalGeneratingUnits):
63 for obj in ThermalGeneratingUnits:
64 obj.CombinedCyclePlant = self
66 def removeThermalGeneratingUnits(self, *ThermalGeneratingUnits):
67 for obj in ThermalGeneratingUnits:
68 obj.CombinedCyclePlant = None