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