Update README.rst
[PyCIM.git] / CIM14 / ENTSOE / Equipment / Generation / Production / FossilFuel.py
blobfe8f1629f53949df330812abefca2fe9e14fb7d1
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.ENTSOE.Equipment.Core.IdentifiedObject import IdentifiedObject
23 class FossilFuel(IdentifiedObject):
24 """The fossil fuel consumed by the non-nuclear thermal generating units, e.g., coal, oil, gas
25 """
27 def __init__(self, fossilFuelType="oil", ThermalGeneratingUnit=None, *args, **kw_args):
28 """Initialises a new 'FossilFuel' instance.
30 @param fossilFuelType: The type of fossil fuel, such as coal, oil, or gas. Values are: "oil", "coal", "lignite", "gas"
31 @param ThermalGeneratingUnit: A thermal generating unit may have one or more fossil fuels
32 """
33 #: The type of fossil fuel, such as coal, oil, or gas. Values are: "oil", "coal", "lignite", "gas"
34 self.fossilFuelType = fossilFuelType
36 self._ThermalGeneratingUnit = None
37 self.ThermalGeneratingUnit = ThermalGeneratingUnit
39 super(FossilFuel, self).__init__(*args, **kw_args)
41 _attrs = ["fossilFuelType"]
42 _attr_types = {"fossilFuelType": str}
43 _defaults = {"fossilFuelType": "oil"}
44 _enums = {"fossilFuelType": "FuelType"}
45 _refs = ["ThermalGeneratingUnit"]
46 _many_refs = []
48 def getThermalGeneratingUnit(self):
49 """A thermal generating unit may have one or more fossil fuels
50 """
51 return self._ThermalGeneratingUnit
53 def setThermalGeneratingUnit(self, value):
54 if self._ThermalGeneratingUnit is not None:
55 self._ThermalGeneratingUnit._FossilFuels = None
57 self._ThermalGeneratingUnit = value
58 if self._ThermalGeneratingUnit is not None:
59 self._ThermalGeneratingUnit.FossilFuels = None
60 self._ThermalGeneratingUnit._FossilFuels = self
62 ThermalGeneratingUnit = property(getThermalGeneratingUnit, setThermalGeneratingUnit)