Packages

final case class EnergyConsumer(EnergyConnection: EnergyConnection = null, customerCount: Int = 0, grounded: Boolean = false, p: Double = 0.0, pfixed: Double = 0.0, pfixedPct: Double = 0.0, phaseConnection: String = null, q: Double = 0.0, qfixed: Double = 0.0, qfixedPct: Double = 0.0, EnergyConsumerAction: String = null, EnergyConsumerPhase: List[String] = null, LoadDynamics: String = null, LoadResponse: String = null, PowerCutZone: String = null) extends Element with Product with Serializable

Generic user of energy - a point of consumption on the power system model.

EnergyConsumer.pfixed, .qfixed, .pfixedPct and .qfixedPct have meaning only if there is no LoadResponseCharacteristic associated with EnergyConsumer or if LoadResponseCharacteristic.exponentModel is set to False.

EnergyConnection

EnergyConnection Reference to the superclass object.

customerCount

Number of individual customers represented by this demand.

grounded

Used for Yn and Zn connections. True if the neutral is solidly grounded.

p

Active power of the load. Load sign convention is used, i.e. positive sign means flow out from a node. For voltage dependent loads the value is at rated voltage. Starting value for a steady state solution.

pfixed

Active power of the load that is a fixed quantity and does not vary as load group value varies. Load sign convention is used, i.e. positive sign means flow out from a node.

pfixedPct

Fixed active power as a percentage of load group fixed active power. Used to represent the time-varying components. Load sign convention is used, i.e. positive sign means flow out from a node.

phaseConnection

The type of phase connection, such as wye or delta.

q

Reactive power of the load. Load sign convention is used, i.e. positive sign means flow out from a node. For voltage dependent loads the value is at rated voltage. Starting value for a steady state solution.

qfixed

Reactive power of the load that is a fixed quantity and does not vary as load group value varies. Load sign convention is used, i.e. positive sign means flow out from a node.

qfixedPct

Fixed reactive power as a percentage of load group fixed reactive power. Used to represent the time-varying components. Load sign convention is used, i.e. positive sign means flow out from a node.

EnergyConsumerAction

EnergyConsumerAction undocumented

EnergyConsumerPhase

EnergyConsumerPhase The individual phase models for this energy consumer.

LoadDynamics

LoadDynamics Load dynamics model used to describe dynamic behaviour of this energy consumer.

LoadResponse

LoadResponseCharacteristic The load response characteristic of this load. If missing, this load is assumed to be constant power.

PowerCutZone

PowerCutZone The energy consumer is assigned to this power cut zone.

Linear Supertypes
Element, Product, Equals, Cloneable, Cloneable, Row, Serializable, Serializable, AnyRef, Any
Ordering
  1. Grouped
  2. Alphabetic
  3. By Inheritance
Inherited
  1. EnergyConsumer
  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 EnergyConsumer(EnergyConnection: EnergyConnection = null, customerCount: Int = 0, grounded: Boolean = false, p: Double = 0.0, pfixed: Double = 0.0, pfixedPct: Double = 0.0, phaseConnection: String = null, q: Double = 0.0, qfixed: Double = 0.0, qfixedPct: Double = 0.0, EnergyConsumerAction: String = null, EnergyConsumerPhase: List[String] = null, LoadDynamics: String = null, LoadResponse: String = null, PowerCutZone: String = null)

    EnergyConnection

    EnergyConnection Reference to the superclass object.

    customerCount

    Number of individual customers represented by this demand.

    grounded

    Used for Yn and Zn connections. True if the neutral is solidly grounded.

    p

    Active power of the load. Load sign convention is used, i.e. positive sign means flow out from a node. For voltage dependent loads the value is at rated voltage. Starting value for a steady state solution.

    pfixed

    Active power of the load that is a fixed quantity and does not vary as load group value varies. Load sign convention is used, i.e. positive sign means flow out from a node.

    pfixedPct

    Fixed active power as a percentage of load group fixed active power. Used to represent the time-varying components. Load sign convention is used, i.e. positive sign means flow out from a node.

    phaseConnection

    The type of phase connection, such as wye or delta.

    q

    Reactive power of the load. Load sign convention is used, i.e. positive sign means flow out from a node. For voltage dependent loads the value is at rated voltage. Starting value for a steady state solution.

    qfixed

    Reactive power of the load that is a fixed quantity and does not vary as load group value varies. Load sign convention is used, i.e. positive sign means flow out from a node.

    qfixedPct

    Fixed reactive power as a percentage of load group fixed reactive power. Used to represent the time-varying components. Load sign convention is used, i.e. positive sign means flow out from a node.

    EnergyConsumerAction

    EnergyConsumerAction undocumented

    EnergyConsumerPhase

    EnergyConsumerPhase The individual phase models for this energy consumer.

    LoadDynamics

    LoadDynamics Load dynamics model used to describe dynamic behaviour of this energy consumer.

    LoadResponse

    LoadResponseCharacteristic The load response characteristic of this load. If missing, this load is assumed to be constant power.

    PowerCutZone

    PowerCutZone The energy consumer is assigned to this power cut zone.

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 EnergyConnection: EnergyConnection
  5. val EnergyConsumerAction: String
  6. val EnergyConsumerPhase: List[String]
  7. val LoadDynamics: String
  8. val LoadResponse: String
  9. val PowerCutZone: String
  10. 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
  11. def anyNull: Boolean
    Definition Classes
    Row
  12. def apply(i: Int): Any
    Definition Classes
    Row
  13. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  14. def baseclass: String

    This class name.

    This class name.

    returns

    the class name without the package prefixes

    Definition Classes
    Element
  15. 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
  16. 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
  17. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  18. 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
    EnergyConsumer → Row
  19. val customerCount: Int
  20. 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"/>

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

  22. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  23. def equals(o: Any): Boolean
    Definition Classes
    Row → AnyRef → Any
  24. 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
    EnergyConsumerElement
  25. 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
    EnergyConsumerElement
  26. def fieldIndex(name: String): Int
    Definition Classes
    Row
  27. 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
  28. def getAs[T](fieldName: String): T
    Definition Classes
    Row
  29. def getAs[T](i: Int): T
    Definition Classes
    Row
  30. def getBoolean(i: Int): Boolean
    Definition Classes
    Row
  31. def getByte(i: Int): Byte
    Definition Classes
    Row
  32. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  33. def getDate(i: Int): Date
    Definition Classes
    Row
  34. def getDecimal(i: Int): BigDecimal
    Definition Classes
    Row
  35. def getDouble(i: Int): Double
    Definition Classes
    Row
  36. def getFloat(i: Int): Float
    Definition Classes
    Row
  37. def getInstant(i: Int): Instant
    Definition Classes
    Row
  38. def getInt(i: Int): Int
    Definition Classes
    Row
  39. def getJavaMap[K, V](i: Int): Map[K, V]
    Definition Classes
    Row
  40. def getList[T](i: Int): List[T]
    Definition Classes
    Row
  41. def getLocalDate(i: Int): LocalDate
    Definition Classes
    Row
  42. def getLong(i: Int): Long
    Definition Classes
    Row
  43. def getMap[K, V](i: Int): Map[K, V]
    Definition Classes
    Row
  44. def getSeq[T](i: Int): Seq[T]
    Definition Classes
    Row
  45. def getShort(i: Int): Short
    Definition Classes
    Row
  46. def getString(i: Int): String
    Definition Classes
    Row
  47. def getStruct(i: Int): Row
    Definition Classes
    Row
  48. def getTimestamp(i: Int): Timestamp
    Definition Classes
    Row
  49. def getValuesMap[T](fieldNames: Seq[String]): Map[String, T]
    Definition Classes
    Row
  50. val grounded: Boolean
  51. def hashCode(): Int
    Definition Classes
    Row → AnyRef → Any
  52. 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
  53. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  54. def isNullAt(i: Int): Boolean
    Definition Classes
    Row
  55. def json: String
    Definition Classes
    Row
    Annotations
    @Unstable()
  56. 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
  57. 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
  58. def mkString(start: String, sep: String, end: String): String
    Definition Classes
    Row
  59. def mkString(sep: String): String
    Definition Classes
    Row
  60. def mkString: String
    Definition Classes
    Row
  61. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  62. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  63. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  64. val p: Double
  65. val pfixed: Double
  66. val pfixedPct: Double
  67. val phaseConnection: String
  68. def prettyJson: String
    Definition Classes
    Row
    Annotations
    @Unstable()
  69. val q: Double
  70. val qfixed: Double
  71. val qfixedPct: Double
  72. def schema: StructType
    Definition Classes
    Row
  73. def size: Int
    Definition Classes
    Row
  74. def sup: EnergyConnection

    Return the superclass object.

    Return the superclass object.

    returns

    The typed superclass nested object.

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