CIM14/CPSM/Equipment/Wires/ACLineSegment.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.Wires.Conductor import Conductor
  22
  23 class ACLineSegment(Conductor):
  24     """A wire or combination of wires, with consistent electrical characteristics, building a single electrical system, used to carry alternating current between points in the power system.-  [R4.5] and [R4.7] are satisfied by navigation to ConnectivityNode and Substation -  Each ACLineSegment is required to have an association to a BaseVoltage.  The association to Line is not required. -  Using the “MemberOf_EquipmentContainer” association, an ACLineSegment can only be contained by a Line, but the association to Line is not required. -  Attributes b0ch, g0ch, gch, r0, and x0 are for short circuit only and are not required.
  25     """
  26
  27     def __init__(self, g0ch=0.0, r=0.0, x0=0.0, bch=0.0, x=0.0, b0ch=0.0, gch=0.0, r0=0.0, *args, **kw_args):
  28         """Initialises a new 'ACLineSegment' instance.
  29
  30         @param g0ch: Zero sequence shunt (charging) conductance, uniformly distributed, of the entire line section.
  31         @param r: Positive sequence series resistance of the entire line section.
  32         @param x0: Zero sequence series reactance of the entire line section.
  33         @param bch: Positive sequence shunt (charging) susceptance, uniformly distributed, of the entire line section.  This value represents the full charging over the full length of the line.
  34         @param x: Positive sequence series reactance of the entire line section.
  35         @param b0ch: Zero sequence shunt (charging) susceptance, uniformly distributed, of the entire line section.
  36         @param gch: Positive sequence shunt (charging) conductance, uniformly distributed, of the entire line section.
  37         @param r0: Zero sequence series resistance of the entire line section.
  38         """
  39         #: Zero sequence shunt (charging) conductance, uniformly distributed, of the entire line section.
  40         self.g0ch = g0ch
  41
  42         #: Positive sequence series resistance of the entire line section.
  43         self.r = r
  44
  45         #: Zero sequence series reactance of the entire line section.
  46         self.x0 = x0
  47
  48         #: Positive sequence shunt (charging) susceptance, uniformly distributed, of the entire line section.  This value represents the full charging over the full length of the line.
  49         self.bch = bch
  50
  51         #: Positive sequence series reactance of the entire line section.
  52         self.x = x
  53
  54         #: Zero sequence shunt (charging) susceptance, uniformly distributed, of the entire line section.
  55         self.b0ch = b0ch
  56
  57         #: Positive sequence shunt (charging) conductance, uniformly distributed, of the entire line section.
  58         self.gch = gch
  59
  60         #: Zero sequence series resistance of the entire line section.
  61         self.r0 = r0
  62
  63         super(ACLineSegment, self).__init__(*args, **kw_args)
  64
  65     _attrs = ["g0ch", "r", "x0", "bch", "x", "b0ch", "gch", "r0"]
  66     _attr_types = {"g0ch": float, "r": float, "x0": float, "bch": float, "x": float, "b0ch": float, "gch": float, "r0": float}
  67     _defaults = {"g0ch": 0.0, "r": 0.0, "x0": 0.0, "bch": 0.0, "x": 0.0, "b0ch": 0.0, "gch": 0.0, "r0": 0.0}
  68     _enums = {}
  69     _refs = []
  70     _many_refs = []
  71