CIM14/IEC61970/Wires/EnergySource.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.ConductingEquipment import ConductingEquipment
  22
  23 class EnergySource(ConductingEquipment):
  24     """A generic equivalent for an energy supplier on a transmission or distribution voltage level.
  25     """
  26
  27     def __init__(self, x=0.0, activePower=0.0, r=0.0, nominalVoltage=0.0, voltageMagnitude=0.0, xn=0.0, x0=0.0, rn=0.0, voltageAngle=0.0, r0=0.0, *args, **kw_args):
  28         """Initialises a new 'EnergySource' instance.
  29
  30         @param x: Positive sequence Thevenin reactance.
  31         @param activePower: High voltage source load
  32         @param r: Positive sequence Thevenin resistance.
  33         @param nominalVoltage: Phase-to-phase nominal voltage.
  34         @param voltageMagnitude: Phase-to-phase open circuit voltage magnitude.
  35         @param xn: Negative sequence Thevenin reactance.
  36         @param x0: Zero sequence Thevenin reactance.
  37         @param rn: Negative sequence Thevenin resistance.
  38         @param voltageAngle: Phase angle of a-phase open circuit.
  39         @param r0: Zero sequence Thevenin resistance.
  40         """
  41         #: Positive sequence Thevenin reactance.
  42         self.x = x
  43
  44         #: High voltage source load
  45         self.activePower = activePower
  46
  47         #: Positive sequence Thevenin resistance.
  48         self.r = r
  49
  50         #: Phase-to-phase nominal voltage.
  51         self.nominalVoltage = nominalVoltage
  52
  53         #: Phase-to-phase open circuit voltage magnitude.
  54         self.voltageMagnitude = voltageMagnitude
  55
  56         #: Negative sequence Thevenin reactance.
  57         self.xn = xn
  58
  59         #: Zero sequence Thevenin reactance.
  60         self.x0 = x0
  61
  62         #: Negative sequence Thevenin resistance.
  63         self.rn = rn
  64
  65         #: Phase angle of a-phase open circuit.
  66         self.voltageAngle = voltageAngle
  67
  68         #: Zero sequence Thevenin resistance.
  69         self.r0 = r0
  70
  71         super(EnergySource, self).__init__(*args, **kw_args)
  72
  73     _attrs = ["x", "activePower", "r", "nominalVoltage", "voltageMagnitude", "xn", "x0", "rn", "voltageAngle", "r0"]
  74     _attr_types = {"x": float, "activePower": float, "r": float, "nominalVoltage": float, "voltageMagnitude": float, "xn": float, "x0": float, "rn": float, "voltageAngle": float, "r0": float}
  75     _defaults = {"x": 0.0, "activePower": 0.0, "r": 0.0, "nominalVoltage": 0.0, "voltageMagnitude": 0.0, "xn": 0.0, "x0": 0.0, "rn": 0.0, "voltageAngle": 0.0, "r0": 0.0}
  76     _enums = {}
  77     _refs = []
  78     _many_refs = []
  79