final case class ControlArea(PowerSystemResource: PowerSystemResource = null, netInterchange: Double = 0.0, pTolerance: Double = 0.0, type: String = null, ControlAreaGeneratingUnit: List[String] = null, EnergyArea: String = null, TieFlow: List[String] = null) extends Element with Product with Serializable
A control area is a grouping of generating units and/or loads and a cutset of tie lines (as terminals) which may be used for a variety of purposes including automatic generation control, power flow solution area interchange control specification, and input to load forecasting.
All generation and load within the area defined by the terminals on the border are considered in the area interchange control. Note that any number of overlapping control area specifications can be superimposed on the physical model. The following general principles apply to ControlArea: 1. The control area orientation for net interchange is positive for an import, negative for an export. 2. The control area net interchange is determined by summing flows in Terminals. The Terminals are identified by creating a set of TieFlow objects associated with a ControlArea object. Each TieFlow object identifies one Terminal. 3. In a single network model, a tie between two control areas must be modelled in both control area specifications, such that the two representations of the tie flow sum to zero. 4. The normal orientation of Terminal flow is positive for flow into the conducting equipment that owns the Terminal. (i.e. flow from a bus into a device is positive.) However, the orientation of each flow in the control area specification must align with the control area convention, i.e. import is positive. If the orientation of the Terminal flow referenced by a TieFlow is positive into the control area, then this is confirmed by setting TieFlow.positiveFlowIn flag TRUE. If not, the orientation must be reversed by setting the TieFlow.positiveFlowIn flag FALSE.
- PowerSystemResource
PowerSystemResource Reference to the superclass object.
- netInterchange
The specified positive net interchange into the control area, i.e. positive sign means flow into the area.
- pTolerance
Active power net interchange tolerance. The attribute shall be a positive value or zero.
- type
The primary type of control area definition used to determine if this is used for automatic generation control, for planning interchange control, or other purposes. A control area specified with primary type of automatic generation control could still be forecast and used as an interchange area in power flow analysis.
- ControlAreaGeneratingUnit
ControlAreaGeneratingUnit The generating unit specifications for the control area.
- EnergyArea
EnergyArea The energy area that is forecast from this control area specification.
- TieFlow
TieFlow The tie flows associated with the control area.
- Grouped
- Alphabetic
- By Inheritance
- ControlArea
- Element
- Product
- Equals
- Cloneable
- Cloneable
- Row
- Serializable
- Serializable
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
-
new
ControlArea(PowerSystemResource: PowerSystemResource = null, netInterchange: Double = 0.0, pTolerance: Double = 0.0, type: String = null, ControlAreaGeneratingUnit: List[String] = null, EnergyArea: String = null, TieFlow: List[String] = null)
- PowerSystemResource
PowerSystemResource Reference to the superclass object.
- netInterchange
The specified positive net interchange into the control area, i.e. positive sign means flow into the area.
- pTolerance
Active power net interchange tolerance. The attribute shall be a positive value or zero.
- type
The primary type of control area definition used to determine if this is used for automatic generation control, for planning interchange control, or other purposes. A control area specified with primary type of automatic generation control could still be forecast and used as an interchange area in power flow analysis.
- ControlAreaGeneratingUnit
ControlAreaGeneratingUnit The generating unit specifications for the control area.
- EnergyArea
EnergyArea The energy area that is forecast from this control area specification.
- TieFlow
TieFlow The tie flows associated with the control area.
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 EnergyArea: String
- val PowerSystemResource: PowerSystemResource
- val TieFlow: List[String]
-
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
- ControlArea → 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
-
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
- ControlArea → 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
- ControlArea → 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
- val netInterchange: Double
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- val pTolerance: Double
-
def
prettyJson: String
- Definition Classes
- Row
- Annotations
- @Unstable()
-
def
schema: StructType
- Definition Classes
- Row
-
def
size: Int
- Definition Classes
- Row
-
def
sup: PowerSystemResource
Return the superclass object.
Return the superclass object.
- returns
The typed superclass nested object.
- Definition Classes
- ControlArea → 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
- val type: String
-
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.