Update README.rst
[PyCIM.git] / CIM14 / IEC61970 / Generation / Production / AirCompressor.py
blob1280131ddc10cfc9c6c6888c63c54bbed0ed9a29
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 AirCompressor(PowerSystemResource):
24 """Combustion turbine air compressor which is an integral part of a compressed air energy storage (CAES) plant
25 """
27 def __init__(self, airCompressorRating=0.0, CAESPlant=None, CombustionTurbine=None, *args, **kw_args):
28 """Initialises a new 'AirCompressor' instance.
30 @param airCompressorRating: Rating of the CAES air compressor
31 @param CAESPlant: An air compressor may be a member of a compressed air energy storage plant
32 @param CombustionTurbine: A CAES air compressor is driven by combustion turbine
33 """
34 #: Rating of the CAES air compressor
35 self.airCompressorRating = airCompressorRating
37 self._CAESPlant = None
38 self.CAESPlant = CAESPlant
40 self._CombustionTurbine = None
41 self.CombustionTurbine = CombustionTurbine
43 super(AirCompressor, self).__init__(*args, **kw_args)
45 _attrs = ["airCompressorRating"]
46 _attr_types = {"airCompressorRating": float}
47 _defaults = {"airCompressorRating": 0.0}
48 _enums = {}
49 _refs = ["CAESPlant", "CombustionTurbine"]
50 _many_refs = []
52 def getCAESPlant(self):
53 """An air compressor may be a member of a compressed air energy storage plant
54 """
55 return self._CAESPlant
57 def setCAESPlant(self, value):
58 if self._CAESPlant is not None:
59 self._CAESPlant._AirCompressor = None
61 self._CAESPlant = value
62 if self._CAESPlant is not None:
63 self._CAESPlant.AirCompressor = None
64 self._CAESPlant._AirCompressor = self
66 CAESPlant = property(getCAESPlant, setCAESPlant)
68 def getCombustionTurbine(self):
69 """A CAES air compressor is driven by combustion turbine
70 """
71 return self._CombustionTurbine
73 def setCombustionTurbine(self, value):
74 if self._CombustionTurbine is not None:
75 self._CombustionTurbine._AirCompressor = None
77 self._CombustionTurbine = value
78 if self._CombustionTurbine is not None:
79 self._CombustionTurbine.AirCompressor = None
80 self._CombustionTurbine._AirCompressor = self
82 CombustionTurbine = property(getCombustionTurbine, setCombustionTurbine)