Packages

final case class ExcIEEEDC4B(ExcitationSystemDynamics: ExcitationSystemDynamics = null, efd1: Double = 0.0, efd2: Double = 0.0, ka: Double = 0.0, kd: Double = 0.0, ke: Double = 0.0, kf: Double = 0.0, ki: Double = 0.0, kp: Double = 0.0, oelin: Boolean = false, seefd1: Double = 0.0, seefd2: Double = 0.0, ta: Double = 0.0, td: Double = 0.0, te: Double = 0.0, tf: Double = 0.0, uelin: Boolean = false, vemin: Double = 0.0, vrmax: Double = 0.0, vrmin: Double = 0.0) extends Element with Product with Serializable

IEEE 421.5-2005 type DC4B model.

These excitation systems utilize a field-controlled DC commutator exciter with a continuously acting voltage regulator having supplies obtained from the generator or auxiliary bus. Reference: IEEE 421.5-2005, 5.4.

ExcitationSystemDynamics

ExcitationSystemDynamics Reference to the superclass object.

efd1

Exciter voltage at which exciter saturation is defined (EFD1) (> 0). Typical value = 1,75.

efd2

Exciter voltage at which exciter saturation is defined (EFD2) (> 0). Typical value = 2,33.

ka

Voltage regulator gain (KA) (> 0). Typical value = 1.

kd

Regulator derivative gain (KD) (>= 0). Typical value = 20.

ke

Exciter constant related to self-excited field (KE). Typical value = 1.

kf

Excitation control system stabilizer gain (KF) (>= 0). Typical value = 0.

ki

Regulator integral gain (KI) (>= 0). Typical value = 20.

kp

Regulator proportional gain (KP) (>= 0). Typical value = 20.

oelin

OEL input (OELin). true = LV gate false = subtract from error signal. Typical value = true.

seefd1

Exciter saturation function value at the corresponding exciter voltage, EFD1 (SE[EFD1]) (>= 0). Typical value = 0,08.

seefd2

Exciter saturation function value at the corresponding exciter voltage, EFD2 (SE[EFD2]) (>= 0). Typical value = 0,27.

ta

Voltage regulator time constant (TA) (> 0). Typical value = 0,2.

td

Regulator derivative filter time constant (TD) (> 0 if ExcIEEEDC4B.kd > 0). Typical value = 0,01.

te

Exciter time constant, integration rate associated with exciter control (TE) (> 0). Typical value = 0,8.

tf

Excitation control system stabilizer time constant (TF) (>= 0). Typical value = 1.

uelin

UEL input (UELin). true = HV gate false = add to error signal. Typical value = true.

vemin

Minimum exciter voltage output (VEMIN) (<= 0). Typical value = 0.

vrmax

Maximum voltage regulator output (VRMAX) (> ExcIEEEDC4B.vrmin). Typical value = 2,7.

vrmin

Minimum voltage regulator output (VRMIN) (<= 0 and < ExcIEEEDC4B.vrmax). Typical value = -0,9.

Linear Supertypes
Element, Product, Equals, Cloneable, Cloneable, Row, Serializable, Serializable, AnyRef, Any
Ordering
  1. Grouped
  2. Alphabetic
  3. By Inheritance
Inherited
  1. ExcIEEEDC4B
  2. Element
  3. Product
  4. Equals
  5. Cloneable
  6. Cloneable
  7. Row
  8. Serializable
  9. Serializable
  10. AnyRef
  11. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new ExcIEEEDC4B(ExcitationSystemDynamics: ExcitationSystemDynamics = null, efd1: Double = 0.0, efd2: Double = 0.0, ka: Double = 0.0, kd: Double = 0.0, ke: Double = 0.0, kf: Double = 0.0, ki: Double = 0.0, kp: Double = 0.0, oelin: Boolean = false, seefd1: Double = 0.0, seefd2: Double = 0.0, ta: Double = 0.0, td: Double = 0.0, te: Double = 0.0, tf: Double = 0.0, uelin: Boolean = false, vemin: Double = 0.0, vrmax: Double = 0.0, vrmin: Double = 0.0)

    ExcitationSystemDynamics

    ExcitationSystemDynamics Reference to the superclass object.

    efd1

    Exciter voltage at which exciter saturation is defined (EFD1) (> 0). Typical value = 1,75.

    efd2

    Exciter voltage at which exciter saturation is defined (EFD2) (> 0). Typical value = 2,33.

    ka

    Voltage regulator gain (KA) (> 0). Typical value = 1.

    kd

    Regulator derivative gain (KD) (>= 0). Typical value = 20.

    ke

    Exciter constant related to self-excited field (KE). Typical value = 1.

    kf

    Excitation control system stabilizer gain (KF) (>= 0). Typical value = 0.

    ki

    Regulator integral gain (KI) (>= 0). Typical value = 20.

    kp

    Regulator proportional gain (KP) (>= 0). Typical value = 20.

    oelin

    OEL input (OELin). true = LV gate false = subtract from error signal. Typical value = true.

    seefd1

    Exciter saturation function value at the corresponding exciter voltage, EFD1 (SE[EFD1]) (>= 0). Typical value = 0,08.

    seefd2

    Exciter saturation function value at the corresponding exciter voltage, EFD2 (SE[EFD2]) (>= 0). Typical value = 0,27.

    ta

    Voltage regulator time constant (TA) (> 0). Typical value = 0,2.

    td

    Regulator derivative filter time constant (TD) (> 0 if ExcIEEEDC4B.kd > 0). Typical value = 0,01.

    te

    Exciter time constant, integration rate associated with exciter control (TE) (> 0). Typical value = 0,8.

    tf

    Excitation control system stabilizer time constant (TF) (>= 0). Typical value = 1.

    uelin

    UEL input (UELin). true = HV gate false = add to error signal. Typical value = true.

    vemin

    Minimum exciter voltage output (VEMIN) (<= 0). Typical value = 0.

    vrmax

    Maximum voltage regulator output (VRMAX) (> ExcIEEEDC4B.vrmin). Typical value = 2,7.

    vrmin

    Minimum voltage regulator output (VRMIN) (<= 0 and < ExcIEEEDC4B.vrmax). Typical value = -0,9.

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. val ExcitationSystemDynamics: ExcitationSystemDynamics
  5. def about: Boolean

    Flag for rdf:about elements.

    Flag for rdf:about elements.

    returns

    true if this is an rdf:about element, false otherwise.

    Definition Classes
    Element
  6. def anyNull: Boolean
    Definition Classes
    Row
  7. def apply(i: Int): Any
    Definition Classes
    Row
  8. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  9. def baseclass: String

    This class name.

    This class name.

    returns

    the class name without the package prefixes

    Definition Classes
    Element
  10. val bitfields: Array[Int]

    Valid fields bitmap.

    Valid fields bitmap.

    One (1) in a bit position means that field was found in parsing, zero means it has an indeterminate value. Field order is specified by the fields array.

    For classes constructed manually, we initially fill this in with the worst case scenario. ToDo: this won't work for classes with more than 128 fields (so far none).

    Definition Classes
    Element
  11. def classes: Seq[String]

    This class and the hierarchical list of classes this class derives from.

    This class and the hierarchical list of classes this class derives from.

    returns

    the list of classes without the package prefixes.

    Definition Classes
    Element
  12. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  13. def copy(): Row

    Return a copy of this object as a Row.

    Return a copy of this object as a Row.

    Creates a clone of this object for use in Row manipulations.

    returns

    The copy of the object.

    Definition Classes
    ExcIEEEDC4B → Row
  14. val efd1: Double
  15. val efd2: Double
  16. def emit_attribute(field: String, value: Any)(implicit clz: String, s: StringBuilder): Unit

    Emit one XML attribute.

    Emit one XML attribute.

    field

    The name of the field.

    value

    The value of the field.

    clz

    The class name (e.g. ACLineSegment) of this element

    s

    The builder to write into.

    Definition Classes
    Element
    Example:
    1. <cim:Location.CoordinateSystem rdf:resource="#wgs84"/>

  17. def emit_element(field: String, value: Any)(implicit clz: String, s: StringBuilder): Unit

    Emit one XML element.

    Emit one XML element.

    field

    The name of the field.

    value

    The value of the field.

    clz

    The class name (e.g. ACLineSegment) of this element

    s

    The builder to write into.

    Definition Classes
    Element
    Example:
    1. <cim:IdentifiedObject.name>WGS 84</cim:IdentifiedObject.name>

  18. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. def equals(o: Any): Boolean
    Definition Classes
    Row → AnyRef → Any
  20. def export: String

    Return a string containing this object as XML.

    Return a string containing this object as XML.

    returns

    The XML corresponding to this object.

    Definition Classes
    ExcIEEEDC4BElement
  21. def export_fields: String

    Return a string containing the fields of this object suitable for inclusion in an XML object.

    Return a string containing the fields of this object suitable for inclusion in an XML object.

    returns

    A string with the fields coded in XML

    Definition Classes
    ExcIEEEDC4BElement
  22. def fieldIndex(name: String): Int
    Definition Classes
    Row
  23. def get(i: Int): AnyRef

    Get the value of the field at index i.

    Get the value of the field at index i.

    i

    The index of the field desired.

    returns

    The value stored in the field, or null if none.

    Definition Classes
    Element → Row
  24. def getAs[T](fieldName: String): T
    Definition Classes
    Row
  25. def getAs[T](i: Int): T
    Definition Classes
    Row
  26. def getBoolean(i: Int): Boolean
    Definition Classes
    Row
  27. def getByte(i: Int): Byte
    Definition Classes
    Row
  28. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  29. def getDate(i: Int): Date
    Definition Classes
    Row
  30. def getDecimal(i: Int): BigDecimal
    Definition Classes
    Row
  31. def getDouble(i: Int): Double
    Definition Classes
    Row
  32. def getFloat(i: Int): Float
    Definition Classes
    Row
  33. def getInstant(i: Int): Instant
    Definition Classes
    Row
  34. def getInt(i: Int): Int
    Definition Classes
    Row
  35. def getJavaMap[K, V](i: Int): Map[K, V]
    Definition Classes
    Row
  36. def getList[T](i: Int): List[T]
    Definition Classes
    Row
  37. def getLocalDate(i: Int): LocalDate
    Definition Classes
    Row
  38. def getLong(i: Int): Long
    Definition Classes
    Row
  39. def getMap[K, V](i: Int): Map[K, V]
    Definition Classes
    Row
  40. def getSeq[T](i: Int): Seq[T]
    Definition Classes
    Row
  41. def getShort(i: Int): Short
    Definition Classes
    Row
  42. def getString(i: Int): String
    Definition Classes
    Row
  43. def getStruct(i: Int): Row
    Definition Classes
    Row
  44. def getTimestamp(i: Int): Timestamp
    Definition Classes
    Row
  45. def getValuesMap[T](fieldNames: Seq[String]): Map[String, T]
    Definition Classes
    Row
  46. def hashCode(): Int
    Definition Classes
    Row → AnyRef → Any
  47. def id: String

    Return the unique ID for the object, the mRID for IdentifiedObject derived classes.

    Return the unique ID for the object, the mRID for IdentifiedObject derived classes.

    returns

    The object ID.

    Definition Classes
    Element
  48. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  49. def isNullAt(i: Int): Boolean
    Definition Classes
    Row
  50. def json: String
    Definition Classes
    Row
    Annotations
    @Unstable()
  51. val ka: Double
  52. val kd: Double
  53. val ke: Double
  54. val kf: Double
  55. val ki: Double
  56. val kp: Double
  57. def length: Int

    The number of fields in the object definition.

    The number of fields in the object definition.

    returns

    The number of defined fields for use in Row manipulations.

    Definition Classes
    Element → Row
  58. def mask(position: Int): Boolean

    Is a field present predicate.

    Is a field present predicate.

    Determines if the field at the given position was encountered while parsing.

    position

    the field position in the fields array

    returns

    true if the field was parsed, false otherwise.

    Definition Classes
    Element
  59. def mkString(start: String, sep: String, end: String): String
    Definition Classes
    Row
  60. def mkString(sep: String): String
    Definition Classes
    Row
  61. def mkString: String
    Definition Classes
    Row
  62. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  63. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  64. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  65. val oelin: Boolean
  66. def prettyJson: String
    Definition Classes
    Row
    Annotations
    @Unstable()
  67. def schema: StructType
    Definition Classes
    Row
  68. val seefd1: Double
  69. val seefd2: Double
  70. def size: Int
    Definition Classes
    Row
  71. def sup: ExcitationSystemDynamics

    Return the superclass object.

    Return the superclass object.

    returns

    The typed superclass nested object.

    Definition Classes
    ExcIEEEDC4BElement
  72. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  73. val ta: Double
  74. val td: Double
  75. val te: Double
  76. val tf: Double
  77. def toSeq: Seq[Any]
    Definition Classes
    Row
  78. def toString(): String
    Definition Classes
    Row → AnyRef → Any
  79. val uelin: Boolean
  80. val vemin: Double
  81. val vrmax: Double
  82. val vrmin: Double
  83. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  84. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  85. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated @deprecated
    Deprecated

    (Since version ) see corresponding Javadoc for more information.

Inherited from Element

Inherited from Product

Inherited from Equals

Inherited from Cloneable

Inherited from Cloneable

Inherited from Row

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Hierarchy

Row

Serialization

Ungrouped