Packages

final case class LoadResponseCharacteristic(IdentifiedObject: IdentifiedObject = null, exponentModel: Boolean = false, pConstantCurrent: Double = 0.0, pConstantImpedance: Double = 0.0, pConstantPower: Double = 0.0, pFrequencyExponent: Double = 0.0, pVoltageExponent: Double = 0.0, qConstantCurrent: Double = 0.0, qConstantImpedance: Double = 0.0, qConstantPower: Double = 0.0, qFrequencyExponent: Double = 0.0, qVoltageExponent: Double = 0.0, EnergyConsumer: List[String] = null) extends Element with Product with Serializable

Models the characteristic response of the load demand due to changes in system conditions such as voltage and frequency.

It is not related to demand response. If LoadResponseCharacteristic.exponentModel is True, the exponential voltage or frequency dependent models are specified and used as to calculate active and reactive power components of the load model. The equations to calculate active and reactive power components of the load model are internal to the power flow calculation, hence they use different quantities depending on the use case of the data exchange. The equations for exponential voltage dependent load model injected power are: pInjection= Pnominal* (Voltage/cim:BaseVoltage.nominalVoltage) ** cim:LoadResponseCharacteristic.pVoltageExponent qInjection= Qnominal* (Voltage/cim:BaseVoltage.nominalVoltage) ** cim:LoadResponseCharacteristic.qVoltageExponent Where: 1) * means "multiply" and ** is "raised to power of"; 2) Pnominal and Qnominal represent the active power and reactive power at nominal voltage as any load described by the voltage exponential model shall be given at nominal voltage. This means that EnergyConsumer.p and EnergyConsumer.q are at nominal voltage. 3) After power flow is solved: -pInjection and qInjection correspond to SvPowerflow.p and SvPowerflow.q respectively. - Voltage corresponds to SvVoltage.v at the TopologicalNode where the load is connected.

IdentifiedObject

IdentifiedObject Reference to the superclass object.

exponentModel

Indicates the exponential voltage dependency model is to be used. If false, the coefficient model is to be used. The exponential voltage dependency model consist of the attributes:

  • pVoltageExponent
  • qVoltageExponent
  • pFrequencyExponent
  • qFrequencyExponent. The coefficient model consist of the attributes:
  • pConstantImpedance
  • pConstantCurrent
  • pConstantPower
  • qConstantImpedance
  • qConstantCurrent
  • qConstantPower. The sum of pConstantImpedance, pConstantCurrent and pConstantPower shall equal 1. The sum of qConstantImpedance, qConstantCurrent and qConstantPower shall equal 1.
pConstantCurrent

Portion of active power load modelled as constant current.

pConstantImpedance

Portion of active power load modelled as constant impedance.

pConstantPower

Portion of active power load modelled as constant power.

pFrequencyExponent

Exponent of per unit frequency effecting active power.

pVoltageExponent

Exponent of per unit voltage effecting real power.

qConstantCurrent

Portion of reactive power load modelled as constant current.

qConstantImpedance

Portion of reactive power load modelled as constant impedance.

qConstantPower

Portion of reactive power load modelled as constant power.

qFrequencyExponent

Exponent of per unit frequency effecting reactive power.

qVoltageExponent

Exponent of per unit voltage effecting reactive power.

EnergyConsumer

EnergyConsumer The set of loads that have the response characteristics.

Linear Supertypes
Element, Product, Equals, Cloneable, Cloneable, Row, Serializable, Serializable, AnyRef, Any
Ordering
  1. Grouped
  2. Alphabetic
  3. By Inheritance
Inherited
  1. LoadResponseCharacteristic
  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 LoadResponseCharacteristic(IdentifiedObject: IdentifiedObject = null, exponentModel: Boolean = false, pConstantCurrent: Double = 0.0, pConstantImpedance: Double = 0.0, pConstantPower: Double = 0.0, pFrequencyExponent: Double = 0.0, pVoltageExponent: Double = 0.0, qConstantCurrent: Double = 0.0, qConstantImpedance: Double = 0.0, qConstantPower: Double = 0.0, qFrequencyExponent: Double = 0.0, qVoltageExponent: Double = 0.0, EnergyConsumer: List[String] = null)

    IdentifiedObject

    IdentifiedObject Reference to the superclass object.

    exponentModel

    Indicates the exponential voltage dependency model is to be used. If false, the coefficient model is to be used. The exponential voltage dependency model consist of the attributes:

    • pVoltageExponent
    • qVoltageExponent
    • pFrequencyExponent
    • qFrequencyExponent. The coefficient model consist of the attributes:
    • pConstantImpedance
    • pConstantCurrent
    • pConstantPower
    • qConstantImpedance
    • qConstantCurrent
    • qConstantPower. The sum of pConstantImpedance, pConstantCurrent and pConstantPower shall equal 1. The sum of qConstantImpedance, qConstantCurrent and qConstantPower shall equal 1.
    pConstantCurrent

    Portion of active power load modelled as constant current.

    pConstantImpedance

    Portion of active power load modelled as constant impedance.

    pConstantPower

    Portion of active power load modelled as constant power.

    pFrequencyExponent

    Exponent of per unit frequency effecting active power.

    pVoltageExponent

    Exponent of per unit voltage effecting real power.

    qConstantCurrent

    Portion of reactive power load modelled as constant current.

    qConstantImpedance

    Portion of reactive power load modelled as constant impedance.

    qConstantPower

    Portion of reactive power load modelled as constant power.

    qFrequencyExponent

    Exponent of per unit frequency effecting reactive power.

    qVoltageExponent

    Exponent of per unit voltage effecting reactive power.

    EnergyConsumer

    EnergyConsumer The set of loads that have the response characteristics.

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 EnergyConsumer: List[String]
  5. val IdentifiedObject: IdentifiedObject
  6. 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
  7. def anyNull: Boolean
    Definition Classes
    Row
  8. def apply(i: Int): Any
    Definition Classes
    Row
  9. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  10. def baseclass: String

    This class name.

    This class name.

    returns

    the class name without the package prefixes

    Definition Classes
    Element
  11. 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
  12. 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
  13. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  14. 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
    LoadResponseCharacteristic → Row
  15. 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"/>

  16. 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>

  17. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. def equals(o: Any): Boolean
    Definition Classes
    Row → AnyRef → Any
  19. val exponentModel: Boolean
  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
    LoadResponseCharacteristicElement
  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
    LoadResponseCharacteristicElement
  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. 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
  52. 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
  53. def mkString(start: String, sep: String, end: String): String
    Definition Classes
    Row
  54. def mkString(sep: String): String
    Definition Classes
    Row
  55. def mkString: String
    Definition Classes
    Row
  56. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  57. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  58. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  59. val pConstantCurrent: Double
  60. val pConstantImpedance: Double
  61. val pConstantPower: Double
  62. val pFrequencyExponent: Double
  63. val pVoltageExponent: Double
  64. def prettyJson: String
    Definition Classes
    Row
    Annotations
    @Unstable()
  65. val qConstantCurrent: Double
  66. val qConstantImpedance: Double
  67. val qConstantPower: Double
  68. val qFrequencyExponent: Double
  69. val qVoltageExponent: Double
  70. def schema: StructType
    Definition Classes
    Row
  71. def size: Int
    Definition Classes
    Row
  72. def sup: IdentifiedObject

    Return the superclass object.

    Return the superclass object.

    returns

    The typed superclass nested object.

    Definition Classes
    LoadResponseCharacteristicElement
  73. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  74. def toSeq: Seq[Any]
    Definition Classes
    Row
  75. def toString(): String
    Definition Classes
    Row → AnyRef → Any
  76. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  77. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  78. 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