CIM14/CPSM/Equipment/Equivalents/EquivalentInjection.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.CPSM.Equipment.Equivalents.EquivalentEquipment import EquivalentEquipment
  22
  23 class EquivalentInjection(EquivalentEquipment):
  24     """This class represents equivalent injections (generation or load).  Voltage regulation is allowed only at the local connectivity node.
  25     """
  26
  27     def __init__(self, regulationCapability=False, maxP=0.0, regulationStatus=False, minP=0.0, regulationTarget=0.0, *args, **kw_args):
  28         """Initialises a new 'EquivalentInjection' instance.
  29
  30         @param regulationCapability: Specifies whether or not the EquivalentInjection has the capability to regulate the local voltage.
  31         @param maxP: Minimum active power of the injection.
  32         @param regulationStatus: Specifies the default regulation status of the EquivalentInjection.  True is regulating.  False is not regulating.
  33         @param minP: Maximum active power of the injection.
  34         @param regulationTarget: The target voltage for voltage regulation.
  35         """
  36         #: Specifies whether or not the EquivalentInjection has the capability to regulate the local voltage.
  37         self.regulationCapability = regulationCapability
  38
  39         #: Minimum active power of the injection.
  40         self.maxP = maxP
  41
  42         #: Specifies the default regulation status of the EquivalentInjection.  True is regulating.  False is not regulating.
  43         self.regulationStatus = regulationStatus
  44
  45         #: Maximum active power of the injection.
  46         self.minP = minP
  47
  48         #: The target voltage for voltage regulation.
  49         self.regulationTarget = regulationTarget
  50
  51         super(EquivalentInjection, self).__init__(*args, **kw_args)
  52
  53     _attrs = ["regulationCapability", "maxP", "regulationStatus", "minP", "regulationTarget"]
  54     _attr_types = {"regulationCapability": bool, "maxP": float, "regulationStatus": bool, "minP": float, "regulationTarget": float}
  55     _defaults = {"regulationCapability": False, "maxP": 0.0, "regulationStatus": False, "minP": 0.0, "regulationTarget": 0.0}
  56     _enums = {}
  57     _refs = []
  58     _many_refs = []
  59