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.
- Grouped
- Alphabetic
- By Inheritance
- LoadResponseCharacteristic
- Element
- Product
- Equals
- Cloneable
- Cloneable
- Row
- Serializable
- Serializable
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
-
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
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- val EnergyConsumer: List[String]
- val IdentifiedObject: IdentifiedObject
-
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
-
def
anyNull: Boolean
- Definition Classes
- Row
-
def
apply(i: Int): Any
- Definition Classes
- Row
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
baseclass: String
This class name.
-
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
-
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
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native() @HotSpotIntrinsicCandidate()
-
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
-
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
<cim:Location.CoordinateSystem rdf:resource="#wgs84"/>
Example: -
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
<cim:IdentifiedObject.name>WGS 84</cim:IdentifiedObject.name>
Example: -
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(o: Any): Boolean
- Definition Classes
- Row → AnyRef → Any
- val exponentModel: Boolean
-
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
- LoadResponseCharacteristic → Element
-
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
- LoadResponseCharacteristic → Element
-
def
fieldIndex(name: String): Int
- Definition Classes
- Row
-
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
-
def
getAs[T](fieldName: String): T
- Definition Classes
- Row
-
def
getAs[T](i: Int): T
- Definition Classes
- Row
-
def
getBoolean(i: Int): Boolean
- Definition Classes
- Row
-
def
getByte(i: Int): Byte
- Definition Classes
- Row
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
def
getDate(i: Int): Date
- Definition Classes
- Row
-
def
getDecimal(i: Int): BigDecimal
- Definition Classes
- Row
-
def
getDouble(i: Int): Double
- Definition Classes
- Row
-
def
getFloat(i: Int): Float
- Definition Classes
- Row
-
def
getInstant(i: Int): Instant
- Definition Classes
- Row
-
def
getInt(i: Int): Int
- Definition Classes
- Row
-
def
getJavaMap[K, V](i: Int): Map[K, V]
- Definition Classes
- Row
-
def
getList[T](i: Int): List[T]
- Definition Classes
- Row
-
def
getLocalDate(i: Int): LocalDate
- Definition Classes
- Row
-
def
getLong(i: Int): Long
- Definition Classes
- Row
-
def
getMap[K, V](i: Int): Map[K, V]
- Definition Classes
- Row
-
def
getSeq[T](i: Int): Seq[T]
- Definition Classes
- Row
-
def
getShort(i: Int): Short
- Definition Classes
- Row
-
def
getString(i: Int): String
- Definition Classes
- Row
-
def
getStruct(i: Int): Row
- Definition Classes
- Row
-
def
getTimestamp(i: Int): Timestamp
- Definition Classes
- Row
-
def
getValuesMap[T](fieldNames: Seq[String]): Map[String, T]
- Definition Classes
- Row
-
def
hashCode(): Int
- Definition Classes
- Row → AnyRef → Any
-
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
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
def
isNullAt(i: Int): Boolean
- Definition Classes
- Row
-
def
json: String
- Definition Classes
- Row
- Annotations
- @Unstable()
-
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
-
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
-
def
mkString(start: String, sep: String, end: String): String
- Definition Classes
- Row
-
def
mkString(sep: String): String
- Definition Classes
- Row
-
def
mkString: String
- Definition Classes
- Row
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- val pConstantCurrent: Double
- val pConstantImpedance: Double
- val pConstantPower: Double
- val pFrequencyExponent: Double
- val pVoltageExponent: Double
-
def
prettyJson: String
- Definition Classes
- Row
- Annotations
- @Unstable()
- val qConstantCurrent: Double
- val qConstantImpedance: Double
- val qConstantPower: Double
- val qFrequencyExponent: Double
- val qVoltageExponent: Double
-
def
schema: StructType
- Definition Classes
- Row
-
def
size: Int
- Definition Classes
- Row
-
def
sup: IdentifiedObject
Return the superclass object.
Return the superclass object.
- returns
The typed superclass nested object.
- Definition Classes
- LoadResponseCharacteristic → Element
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toSeq: Seq[Any]
- Definition Classes
- Row
-
def
toString(): String
- Definition Classes
- Row → AnyRef → Any
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
Deprecated Value Members
-
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.