CIM14/IEC61970/Generation/Production/CAESPlant.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 CIM14.IEC61970.Core.PowerSystemResource import PowerSystemResource
  22
  23 class CAESPlant(PowerSystemResource):
  24     """Compressed air energy storage plant
  25     """
  26
  27     def __init__(self, energyStorageCapacity=0.0, ratedCapacityP=0.0, AirCompressor=None, ThermalGeneratingUnit=None, *args, **kw_args):
  28         """Initialises a new 'CAESPlant' instance.
  29
  30         @param energyStorageCapacity: The rated energy storage capacity.
  31         @param ratedCapacityP: The CAES plant's gross rated generating capacity
  32         @param AirCompressor: An air compressor may be a member of a compressed air energy storage plant
  33         @param ThermalGeneratingUnit: A thermal generating unit may be a member of a compressed air energy storage plant
  34         """
  35         #: The rated energy storage capacity.
  36         self.energyStorageCapacity = energyStorageCapacity
  37
  38         #: The CAES plant's gross rated generating capacity
  39         self.ratedCapacityP = ratedCapacityP
  40
  41         self._AirCompressor = None
  42         self.AirCompressor = AirCompressor
  43
  44         self._ThermalGeneratingUnit = None
  45         self.ThermalGeneratingUnit = ThermalGeneratingUnit
  46
  47         super(CAESPlant, self).__init__(*args, **kw_args)
  48
  49     _attrs = ["energyStorageCapacity", "ratedCapacityP"]
  50     _attr_types = {"energyStorageCapacity": float, "ratedCapacityP": float}
  51     _defaults = {"energyStorageCapacity": 0.0, "ratedCapacityP": 0.0}
  52     _enums = {}
  53     _refs = ["AirCompressor", "ThermalGeneratingUnit"]
  54     _many_refs = []
  55
  56     def getAirCompressor(self):
  57         """An air compressor may be a member of a compressed air energy storage plant
  58         """
  59         return self._AirCompressor
  60
  61     def setAirCompressor(self, value):
  62         if self._AirCompressor is not None:
  63             self._AirCompressor._CAESPlant = None
  64
  65         self._AirCompressor = value
  66         if self._AirCompressor is not None:
  67             self._AirCompressor.CAESPlant = None
  68             self._AirCompressor._CAESPlant = self
  69
  70     AirCompressor = property(getAirCompressor, setAirCompressor)
  71
  72     def getThermalGeneratingUnit(self):
  73         """A thermal generating unit may be a member of a compressed air energy storage plant
  74         """
  75         return self._ThermalGeneratingUnit
  76
  77     def setThermalGeneratingUnit(self, value):
  78         if self._ThermalGeneratingUnit is not None:
  79             self._ThermalGeneratingUnit._CAESPlant = None
  80
  81         self._ThermalGeneratingUnit = value
  82         if self._ThermalGeneratingUnit is not None:
  83             self._ThermalGeneratingUnit.CAESPlant = None
  84             self._ThermalGeneratingUnit._CAESPlant = self
  85
  86     ThermalGeneratingUnit = property(getThermalGeneratingUnit, setThermalGeneratingUnit)
  87