final case class GeneratingUnit(Equipment: Equipment = null, allocSpinResP: Double = 0.0, autoCntrlMarginP: Double = 0.0, baseP: Double = 0.0, controlDeadband: Double = 0.0, controlPulseHigh: Double = 0.0, controlPulseLow: Double = 0.0, controlResponseRate: Double = 0.0, efficiency: Double = 0.0, genControlMode: String = null, genControlSource: String = null, governorMPL: Double = 0.0, governorSCD: Double = 0.0, highControlLimit: Double = 0.0, initialP: Double = 0.0, longPF: Double = 0.0, lowControlLimit: Double = 0.0, lowerRampRate: Double = 0.0, maxEconomicP: Double = 0.0, maxOperatingP: Double = 0.0, maximumAllowableSpinningReserve: Double = 0.0, minEconomicP: Double = 0.0, minOperatingP: Double = 0.0, minimumOffTime: Double = 0.0, modelDetail: Int = 0, nominalP: Double = 0.0, normalPF: Double = 0.0, penaltyFactor: Double = 0.0, raiseRampRate: Double = 0.0, ratedGrossMaxP: Double = 0.0, ratedGrossMinP: Double = 0.0, ratedNetMaxP: Double = 0.0, shortPF: Double = 0.0, startupCost: Double = 0.0, startupTime: Double = 0.0, tieLinePF: Double = 0.0, totalEfficiency: Double = 0.0, variableCost: Double = 0.0, ControlAreaGeneratingUnit: List[String] = null, GenUnitOpCostCurves: List[String] = null, GenUnitOpSchedule: String = null, GrossToNetActivePowerCurves: List[String] = null, RotatingMachine: List[String] = null) extends Element with Product with Serializable
A single or set of synchronous machines for converting mechanical power into alternating-current power.
For example, individual machines within a set may be defined for scheduling purposes while a single control signal is derived for the set. In this case there would be a GeneratingUnit for each member of the set and an additional GeneratingUnit corresponding to the set.
- Equipment
Equipment Reference to the superclass object.
- allocSpinResP
The planned unused capacity (spinning reserve) which can be used to support emergency load.
- autoCntrlMarginP
The planned unused capacity which can be used to support automatic control overruns.
- baseP
For dispatchable units, this value represents the economic active power basepoint, for units that are not dispatchable, this value represents the fixed generation value. The value shall be between the operating low and high limits.
- controlDeadband
Unit control error deadband. When a unit's desired active power change is less than this deadband, then no control pulses will be sent to the unit.
- controlPulseHigh
Pulse high limit which is the largest control pulse that the unit can respond to.
- controlPulseLow
Pulse low limit which is the smallest control pulse that the unit can respond to.
- controlResponseRate
Unit response rate which specifies the active power change for a control pulse of one second in the most responsive loading level of the unit.
- efficiency
The efficiency of the unit in converting mechanical energy, from the prime mover, into electrical energy.
- genControlMode
The unit control mode.
- genControlSource
The source of controls for a generating unit. Defines the control status of the generating unit.
- governorMPL
Governor motor position limit.
- governorSCD
Governor Speed Changer Droop. This is the change in generator power output divided by the change in frequency normalized by the nominal power of the generator and the nominal frequency and expressed in percent and negated. A positive value of speed change droop provides additional generator output upon a drop in frequency.
- highControlLimit
High limit for secondary (AGC) control.
- initialP
Default initial active power which is used to store a powerflow result for the initial active power for this unit in this network configuration.
- longPF
Generating unit long term economic participation factor.
- lowControlLimit
Low limit for secondary (AGC) control.
- lowerRampRate
The normal maximum rate the generating unit active power output can be lowered by control actions.
- maxEconomicP
Maximum high economic active power limit, that should not exceed the maximum operating active power limit.
- maxOperatingP
This is the maximum operating active power limit the dispatcher can enter for this unit.
- maximumAllowableSpinningReserve
Maximum allowable spinning reserve. Spinning reserve will never be considered greater than this value regardless of the current operating point.
- minEconomicP
Low economic active power limit that shall be greater than or equal to the minimum operating active power limit.
- minOperatingP
This is the minimum operating active power limit the dispatcher can enter for this unit.
- minimumOffTime
Minimum time interval between unit shutdown and startup.
- modelDetail
Detail level of the generator model data.
- nominalP
The nominal power of the generating unit. Used to give precise meaning to percentage based attributes such as the governor speed change droop (governorSCD attribute). The attribute shall be a positive value equal to or less than RotatingMachine.ratedS.
- normalPF
Generating unit economic participation factor. The sum of the participation factors across generating units does not have to sum to one. It is used for representing distributed slack participation factor. The attribute shall be a positive value or zero.
- penaltyFactor
Defined as: 1 / ( 1 - Incremental Transmission Loss); with the Incremental Transmission Loss expressed as a plus or minus value. The typical range of penalty factors is (0.9 to 1.1).
- raiseRampRate
The normal maximum rate the generating unit active power output can be raised by control actions.
- ratedGrossMaxP
The unit's gross rated maximum capacity (book value). The attribute shall be a positive value.
- ratedGrossMinP
The gross rated minimum generation level which the unit can safely operate at while delivering power to the transmission grid. The attribute shall be a positive value.
- ratedNetMaxP
The net rated maximum capacity determined by subtracting the auxiliary power used to operate the internal plant machinery from the rated gross maximum capacity. The attribute shall be a positive value.
- shortPF
Generating unit short term economic participation factor.
- startupCost
The initial startup cost incurred for each start of the GeneratingUnit.
- startupTime
Time it takes to get the unit on-line, from the time that the prime mover mechanical power is applied.
- tieLinePF
Generating unit economic participation factor.
- totalEfficiency
The efficiency of the unit in converting the fuel into electrical energy.
- variableCost
The variable cost component of production per unit of ActivePower.
- ControlAreaGeneratingUnit
ControlAreaGeneratingUnit ControlArea specifications for this generating unit.
- GenUnitOpCostCurves
GenUnitOpCostCurve A generating unit may have one or more cost curves, depending upon fuel mixture and fuel cost.
- GenUnitOpSchedule
GenUnitOpSchedule A generating unit may have an operating schedule, indicating the planned operation of the unit.
- GrossToNetActivePowerCurves
GrossToNetActivePowerCurve A generating unit may have a gross active power to net active power curve, describing the losses and auxiliary power requirements of the unit.
- RotatingMachine
RotatingMachine A synchronous machine may operate as a generator and as such becomes a member of a generating unit.
- Grouped
- Alphabetic
- By Inheritance
- GeneratingUnit
- Element
- Product
- Equals
- Cloneable
- Cloneable
- Row
- Serializable
- Serializable
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
-
new
GeneratingUnit(Equipment: Equipment = null, allocSpinResP: Double = 0.0, autoCntrlMarginP: Double = 0.0, baseP: Double = 0.0, controlDeadband: Double = 0.0, controlPulseHigh: Double = 0.0, controlPulseLow: Double = 0.0, controlResponseRate: Double = 0.0, efficiency: Double = 0.0, genControlMode: String = null, genControlSource: String = null, governorMPL: Double = 0.0, governorSCD: Double = 0.0, highControlLimit: Double = 0.0, initialP: Double = 0.0, longPF: Double = 0.0, lowControlLimit: Double = 0.0, lowerRampRate: Double = 0.0, maxEconomicP: Double = 0.0, maxOperatingP: Double = 0.0, maximumAllowableSpinningReserve: Double = 0.0, minEconomicP: Double = 0.0, minOperatingP: Double = 0.0, minimumOffTime: Double = 0.0, modelDetail: Int = 0, nominalP: Double = 0.0, normalPF: Double = 0.0, penaltyFactor: Double = 0.0, raiseRampRate: Double = 0.0, ratedGrossMaxP: Double = 0.0, ratedGrossMinP: Double = 0.0, ratedNetMaxP: Double = 0.0, shortPF: Double = 0.0, startupCost: Double = 0.0, startupTime: Double = 0.0, tieLinePF: Double = 0.0, totalEfficiency: Double = 0.0, variableCost: Double = 0.0, ControlAreaGeneratingUnit: List[String] = null, GenUnitOpCostCurves: List[String] = null, GenUnitOpSchedule: String = null, GrossToNetActivePowerCurves: List[String] = null, RotatingMachine: List[String] = null)
- Equipment
Equipment Reference to the superclass object.
- allocSpinResP
The planned unused capacity (spinning reserve) which can be used to support emergency load.
- autoCntrlMarginP
The planned unused capacity which can be used to support automatic control overruns.
- baseP
For dispatchable units, this value represents the economic active power basepoint, for units that are not dispatchable, this value represents the fixed generation value. The value shall be between the operating low and high limits.
- controlDeadband
Unit control error deadband. When a unit's desired active power change is less than this deadband, then no control pulses will be sent to the unit.
- controlPulseHigh
Pulse high limit which is the largest control pulse that the unit can respond to.
- controlPulseLow
Pulse low limit which is the smallest control pulse that the unit can respond to.
- controlResponseRate
Unit response rate which specifies the active power change for a control pulse of one second in the most responsive loading level of the unit.
- efficiency
The efficiency of the unit in converting mechanical energy, from the prime mover, into electrical energy.
- genControlMode
The unit control mode.
- genControlSource
The source of controls for a generating unit. Defines the control status of the generating unit.
- governorMPL
Governor motor position limit.
- governorSCD
Governor Speed Changer Droop. This is the change in generator power output divided by the change in frequency normalized by the nominal power of the generator and the nominal frequency and expressed in percent and negated. A positive value of speed change droop provides additional generator output upon a drop in frequency.
- highControlLimit
High limit for secondary (AGC) control.
- initialP
Default initial active power which is used to store a powerflow result for the initial active power for this unit in this network configuration.
- longPF
Generating unit long term economic participation factor.
- lowControlLimit
Low limit for secondary (AGC) control.
- lowerRampRate
The normal maximum rate the generating unit active power output can be lowered by control actions.
- maxEconomicP
Maximum high economic active power limit, that should not exceed the maximum operating active power limit.
- maxOperatingP
This is the maximum operating active power limit the dispatcher can enter for this unit.
- maximumAllowableSpinningReserve
Maximum allowable spinning reserve. Spinning reserve will never be considered greater than this value regardless of the current operating point.
- minEconomicP
Low economic active power limit that shall be greater than or equal to the minimum operating active power limit.
- minOperatingP
This is the minimum operating active power limit the dispatcher can enter for this unit.
- minimumOffTime
Minimum time interval between unit shutdown and startup.
- modelDetail
Detail level of the generator model data.
- nominalP
The nominal power of the generating unit. Used to give precise meaning to percentage based attributes such as the governor speed change droop (governorSCD attribute). The attribute shall be a positive value equal to or less than RotatingMachine.ratedS.
- normalPF
Generating unit economic participation factor. The sum of the participation factors across generating units does not have to sum to one. It is used for representing distributed slack participation factor. The attribute shall be a positive value or zero.
- penaltyFactor
Defined as: 1 / ( 1 - Incremental Transmission Loss); with the Incremental Transmission Loss expressed as a plus or minus value. The typical range of penalty factors is (0.9 to 1.1).
- raiseRampRate
The normal maximum rate the generating unit active power output can be raised by control actions.
- ratedGrossMaxP
The unit's gross rated maximum capacity (book value). The attribute shall be a positive value.
- ratedGrossMinP
The gross rated minimum generation level which the unit can safely operate at while delivering power to the transmission grid. The attribute shall be a positive value.
- ratedNetMaxP
The net rated maximum capacity determined by subtracting the auxiliary power used to operate the internal plant machinery from the rated gross maximum capacity. The attribute shall be a positive value.
- shortPF
Generating unit short term economic participation factor.
- startupCost
The initial startup cost incurred for each start of the GeneratingUnit.
- startupTime
Time it takes to get the unit on-line, from the time that the prime mover mechanical power is applied.
- tieLinePF
Generating unit economic participation factor.
- totalEfficiency
The efficiency of the unit in converting the fuel into electrical energy.
- variableCost
The variable cost component of production per unit of ActivePower.
- ControlAreaGeneratingUnit
ControlAreaGeneratingUnit ControlArea specifications for this generating unit.
- GenUnitOpCostCurves
GenUnitOpCostCurve A generating unit may have one or more cost curves, depending upon fuel mixture and fuel cost.
- GenUnitOpSchedule
GenUnitOpSchedule A generating unit may have an operating schedule, indicating the planned operation of the unit.
- GrossToNetActivePowerCurves
GrossToNetActivePowerCurve A generating unit may have a gross active power to net active power curve, describing the losses and auxiliary power requirements of the unit.
- RotatingMachine
RotatingMachine A synchronous machine may operate as a generator and as such becomes a member of a generating unit.
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 ControlAreaGeneratingUnit: List[String]
- val Equipment: Equipment
- val GenUnitOpCostCurves: List[String]
- val GenUnitOpSchedule: String
- val GrossToNetActivePowerCurves: List[String]
- val RotatingMachine: List[String]
-
def
about: Boolean
Flag for rdf:about elements.
Flag for rdf:about elements.
- returns
trueif this is an rdf:about element,falseotherwise.
- Definition Classes
- Element
- val allocSpinResP: Double
-
def
anyNull: Boolean
- Definition Classes
- Row
-
def
apply(i: Int): Any
- Definition Classes
- Row
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
- val autoCntrlMarginP: Double
- val baseP: Double
-
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()
- val controlDeadband: Double
- val controlPulseHigh: Double
- val controlPulseLow: Double
- val controlResponseRate: Double
-
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
- GeneratingUnit → Row
- val efficiency: Double
-
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
-
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
- GeneratingUnit → 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
- GeneratingUnit → Element
-
def
fieldIndex(name: String): Int
- Definition Classes
- Row
- val genControlMode: String
- val genControlSource: String
-
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
nullif 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
- val governorMPL: Double
- val governorSCD: Double
-
def
hashCode(): Int
- Definition Classes
- Row → AnyRef → Any
- val highControlLimit: Double
-
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
- val initialP: Double
-
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
- val longPF: Double
- val lowControlLimit: Double
- val lowerRampRate: Double
-
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
trueif the field was parsed,falseotherwise.
- Definition Classes
- Element
- val maxEconomicP: Double
- val maxOperatingP: Double
- val maximumAllowableSpinningReserve: Double
- val minEconomicP: Double
- val minOperatingP: Double
- val minimumOffTime: Double
-
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
- val modelDetail: Int
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- val nominalP: Double
- val normalPF: Double
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- val penaltyFactor: Double
-
def
prettyJson: String
- Definition Classes
- Row
- Annotations
- @Unstable()
- val raiseRampRate: Double
- val ratedGrossMaxP: Double
- val ratedGrossMinP: Double
- val ratedNetMaxP: Double
-
def
schema: StructType
- Definition Classes
- Row
- val shortPF: Double
-
def
size: Int
- Definition Classes
- Row
- val startupCost: Double
- val startupTime: Double
-
def
sup: Equipment
Return the superclass object.
Return the superclass object.
- returns
The typed superclass nested object.
- Definition Classes
- GeneratingUnit → Element
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
- val tieLinePF: Double
-
def
toSeq: Seq[Any]
- Definition Classes
- Row
-
def
toString(): String
- Definition Classes
- Row → AnyRef → Any
- val totalEfficiency: Double
- val variableCost: Double
-
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.