Fixing website and API documentation links
[PyCIM.git] / CIM14 / IEC61970 / Generation / Production / StartMainFuelCurve.py
blobced7b8695cb8d23c55de43bb4e04e2971c7d72d6
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.Curve import Curve
23 class StartMainFuelCurve(Curve):
24 """The quantity of main fuel (Y-axis) used to restart and repay the auxiliary power consumed versus the number of hours (X-axis) the unit was off line
25 """
27 def __init__(self, mainFuelType="lignite", StartupModel=None, *args, **kw_args):
28 """Initialises a new 'StartMainFuelCurve' instance.
30 @param mainFuelType: Type of main fuel Values are: "lignite", "coal", "oil", "gas"
31 @param StartupModel: The unit's startup model may have a startup main fuel curve
32 """
33 #: Type of main fuel Values are: "lignite", "coal", "oil", "gas"
34 self.mainFuelType = mainFuelType
36 self._StartupModel = None
37 self.StartupModel = StartupModel
39 super(StartMainFuelCurve, self).__init__(*args, **kw_args)
41 _attrs = ["mainFuelType"]
42 _attr_types = {"mainFuelType": str}
43 _defaults = {"mainFuelType": "lignite"}
44 _enums = {"mainFuelType": "FuelType"}
45 _refs = ["StartupModel"]
46 _many_refs = []
48 def getStartupModel(self):
49 """The unit's startup model may have a startup main fuel curve
50 """
51 return self._StartupModel
53 def setStartupModel(self, value):
54 if self._StartupModel is not None:
55 self._StartupModel._StartMainFuelCurve = None
57 self._StartupModel = value
58 if self._StartupModel is not None:
59 self._StartupModel.StartMainFuelCurve = None
60 self._StartupModel._StartMainFuelCurve = self
62 StartupModel = property(getStartupModel, setStartupModel)