CIM14/CDPSM/GIS_Connectivity/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.CDPSM.GIS_Connectivity.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, voltageMagnitude=0.0, voltageAngle=0.0, nominalVoltage=0.0, *args, **kw_args):
  28         """Initialises a new 'EnergySource' instance.
  29
  30         @param x: Positive sequence Thevenin reactance.
  31         @param voltageMagnitude: Phase-to-phase open circuit voltage magnitude.
  32         @param voltageAngle: Phase angle of a-phase open circuit.
  33         @param nominalVoltage: Phase-to-phase nominal voltage.
  34         """
  35         #: Positive sequence Thevenin reactance.
  36         self.x = x
  37
  38         #: Phase-to-phase open circuit voltage magnitude.
  39         self.voltageMagnitude = voltageMagnitude
  40
  41         #: Phase angle of a-phase open circuit.
  42         self.voltageAngle = voltageAngle
  43
  44         #: Phase-to-phase nominal voltage.
  45         self.nominalVoltage = nominalVoltage
  46
  47         super(EnergySource, self).__init__(*args, **kw_args)
  48
  49     _attrs = ["x", "voltageMagnitude", "voltageAngle", "nominalVoltage"]
  50     _attr_types = {"x": float, "voltageMagnitude": float, "voltageAngle": float, "nominalVoltage": float}
  51     _defaults = {"x": 0.0, "voltageMagnitude": 0.0, "voltageAngle": 0.0, "nominalVoltage": 0.0}
  52     _enums = {}
  53     _refs = []
  54     _many_refs = []
  55