CIM14/ENTSOE/Equipment/Wires/ReactiveCapabilityCurve.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.ENTSOE.Equipment.Core.Curve import Curve
  22
  23 class ReactiveCapabilityCurve(Curve):
  24     """Reactive power rating envelope versus the synchronous machine's active power, in both the generating and motoring modes. For each active power value there is a corresponding high and low reactive power limit  value. Typically there will be a separate curve for each coolant condition, such as hydrogen pressure.  The Y1 axis values represent reactive minimum and the Y2 axis values represent reactive maximum.-  ReactiveCapabilityCurves are not required if the reactive power limits of the SynchronousMachine do not vary with real power output. -  By convention, the Y1 axis values represent reactive minimum and the Y2 axis values represent reactive maximum. -  Because the x value will always be specified in MW and the y values will always be specified in MVAr, the xMultiplier, y1Multiplier, and y2Multiplier attributes do not need to be supplied.
  25     """
  26
  27     def __init__(self, y2Unit="A", InitiallyUsedBySynchronousMachines=None, *args, **kw_args):
  28         """Initialises a new 'ReactiveCapabilityCurve' instance.
  29
  30         @param y2Unit: The Y2-axis units of measure. Values are: "A", "rad", "none", "g", "W/Hz", "V", "m2", "VA", "VArh", "N", "Pa", "VAh", "F", "H", "Hz-1", "W/s", "J", "m", "S", "min", "deg", "J/s", "s", "Wh", "m3", "oC", "V/VAr", "s-1", "h", "W", "ohm", "Hz", "VAr", "kg/J"
  31         @param InitiallyUsedBySynchronousMachines: Synchronous machines using this curve as default.
  32         """
  33         #: The Y2-axis units of measure. Values are: "A", "rad", "none", "g", "W/Hz", "V", "m2", "VA", "VArh", "N", "Pa", "VAh", "F", "H", "Hz-1", "W/s", "J", "m", "S", "min", "deg", "J/s", "s", "Wh", "m3", "oC", "V/VAr", "s-1", "h", "W", "ohm", "Hz", "VAr", "kg/J"
  34         self.y2Unit = y2Unit
  35
  36         self._InitiallyUsedBySynchronousMachines = []
  37         self.InitiallyUsedBySynchronousMachines = [] if InitiallyUsedBySynchronousMachines is None else InitiallyUsedBySynchronousMachines
  38
  39         super(ReactiveCapabilityCurve, self).__init__(*args, **kw_args)
  40
  41     _attrs = ["y2Unit"]
  42     _attr_types = {"y2Unit": str}
  43     _defaults = {"y2Unit": "A"}
  44     _enums = {"y2Unit": "UnitSymbol"}
  45     _refs = ["InitiallyUsedBySynchronousMachines"]
  46     _many_refs = ["InitiallyUsedBySynchronousMachines"]
  47
  48     def getInitiallyUsedBySynchronousMachines(self):
  49         """Synchronous machines using this curve as default.
  50         """
  51         return self._InitiallyUsedBySynchronousMachines
  52
  53     def setInitiallyUsedBySynchronousMachines(self, value):
  54         for x in self._InitiallyUsedBySynchronousMachines:
  55             x.InitialReactiveCapabilityCurve = None
  56         for y in value:
  57             y._InitialReactiveCapabilityCurve = self
  58         self._InitiallyUsedBySynchronousMachines = value
  59
  60     InitiallyUsedBySynchronousMachines = property(getInitiallyUsedBySynchronousMachines, setInitiallyUsedBySynchronousMachines)
  61
  62     def addInitiallyUsedBySynchronousMachines(self, *InitiallyUsedBySynchronousMachines):
  63         for obj in InitiallyUsedBySynchronousMachines:
  64             obj.InitialReactiveCapabilityCurve = self
  65
  66     def removeInitiallyUsedBySynchronousMachines(self, *InitiallyUsedBySynchronousMachines):
  67         for obj in InitiallyUsedBySynchronousMachines:
  68             obj.InitialReactiveCapabilityCurve = None
  69