Packages

final case class RegulatingControl(PowerSystemResource: PowerSystemResource = null, discrete: Boolean = false, enabled: Boolean = false, maxAllowedTargetValue: Double = 0.0, minAllowedTargetValue: Double = 0.0, mode: String = null, monitoredPhase: String = null, targetDeadband: Double = 0.0, targetValue: Double = 0.0, targetValueUnitMultiplier: String = null, ProtectiveActionRegulation: List[String] = null, RegulatingCondEq: List[String] = null, RegulationSchedule: List[String] = null, Terminal: String = null) extends Element with Product with Serializable

Specifies a set of equipment that works together to control a power system quantity such as voltage or flow.

Remote bus voltage control is possible by specifying the controlled terminal located at some place remote from the controlling equipment. The specified terminal shall be associated with the connectivity node of the controlled point. The most specific subtype of RegulatingControl shall be used in case such equipment participate in the control, e.g. TapChangerControl for tap changers. For flow control, load sign convention is used, i.e. positive sign means flow out from a TopologicalNode (bus) into the conducting equipment. The attribute minAllowedTargetValue and maxAllowedTargetValue are required in the following cases: - For a power generating module operated in power factor control mode to specify maximum and minimum power factor values; - Whenever it is necessary to have an off center target voltage for the tap changer regulator. For instance, due to long cables to off shore wind farms and the need to have a simpler setup at the off shore transformer platform, the voltage is controlled from the land at the connection point for the off shore wind farm. Since there usually is a voltage rise along the cable, there is typical and overvoltage of up 3-4 kV compared to the on shore station. Thus in normal operation the tap changer on the on shore station is operated with a target set point, which is in the lower parts of the dead band. The attributes minAllowedTargetValue and maxAllowedTargetValue are not related to the attribute targetDeadband and thus they are not treated as an alternative of the targetDeadband. They are needed due to limitations in the local substation controller. The attribute targetDeadband is used to prevent the power flow from move the tap position in circles (hunting) that is to be used regardless of the attributes minAllowedTargetValue and maxAllowedTargetValue.

PowerSystemResource

PowerSystemResource Reference to the superclass object.

discrete

The regulation is performed in a discrete mode. This applies to equipment with discrete controls, e.g. tap changers and shunt compensators.

enabled

The flag tells if regulation is enabled.

maxAllowedTargetValue

Maximum allowed target value (RegulatingControl.targetValue).

minAllowedTargetValue

Minimum allowed target value (RegulatingControl.targetValue).

mode

The regulating control mode presently available. This specification allows for determining the kind of regulation without need for obtaining the units from a schedule.

monitoredPhase

Phase voltage controlling this regulator, measured at regulator location.

targetDeadband

This is a deadband used with discrete control to avoid excessive update of controls like tap changers and shunt compensator banks while regulating. The units of those appropriate for the mode. The attribute shall be a positive value or zero. If RegulatingControl.discrete is set to "false", the RegulatingControl.targetDeadband is to be ignored. Note that for instance, if the targetValue is 100 kV and the targetDeadband is 2 kV the range is from 99 to 101 kV.

targetValue

The target value specified for case input. This value can be used for the target value without the use of schedules. The value has the units appropriate to the mode attribute.

targetValueUnitMultiplier

Specify the multiplier for used for the targetValue.

ProtectiveActionRegulation

ProtectiveActionRegulation Enable/disable a regulating control or set new target value.

RegulatingCondEq

RegulatingCondEq The equipment that participates in this regulating control scheme.

RegulationSchedule

RegulationSchedule Schedule for this regulating control.

Terminal

Terminal The terminal associated with this regulating control. The terminal is associated instead of a node, since the terminal could connect into either a topological node or a connectivity node. Sometimes it is useful to model regulation at a terminal of a bus bar object.

Linear Supertypes
Element, Product, Equals, Cloneable, Cloneable, Row, Serializable, Serializable, AnyRef, Any
Ordering
  1. Grouped
  2. Alphabetic
  3. By Inheritance
Inherited
  1. RegulatingControl
  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 RegulatingControl(PowerSystemResource: PowerSystemResource = null, discrete: Boolean = false, enabled: Boolean = false, maxAllowedTargetValue: Double = 0.0, minAllowedTargetValue: Double = 0.0, mode: String = null, monitoredPhase: String = null, targetDeadband: Double = 0.0, targetValue: Double = 0.0, targetValueUnitMultiplier: String = null, ProtectiveActionRegulation: List[String] = null, RegulatingCondEq: List[String] = null, RegulationSchedule: List[String] = null, Terminal: String = null)

    PowerSystemResource

    PowerSystemResource Reference to the superclass object.

    discrete

    The regulation is performed in a discrete mode. This applies to equipment with discrete controls, e.g. tap changers and shunt compensators.

    enabled

    The flag tells if regulation is enabled.

    maxAllowedTargetValue

    Maximum allowed target value (RegulatingControl.targetValue).

    minAllowedTargetValue

    Minimum allowed target value (RegulatingControl.targetValue).

    mode

    The regulating control mode presently available. This specification allows for determining the kind of regulation without need for obtaining the units from a schedule.

    monitoredPhase

    Phase voltage controlling this regulator, measured at regulator location.

    targetDeadband

    This is a deadband used with discrete control to avoid excessive update of controls like tap changers and shunt compensator banks while regulating. The units of those appropriate for the mode. The attribute shall be a positive value or zero. If RegulatingControl.discrete is set to "false", the RegulatingControl.targetDeadband is to be ignored. Note that for instance, if the targetValue is 100 kV and the targetDeadband is 2 kV the range is from 99 to 101 kV.

    targetValue

    The target value specified for case input. This value can be used for the target value without the use of schedules. The value has the units appropriate to the mode attribute.

    targetValueUnitMultiplier

    Specify the multiplier for used for the targetValue.

    ProtectiveActionRegulation

    ProtectiveActionRegulation Enable/disable a regulating control or set new target value.

    RegulatingCondEq

    RegulatingCondEq The equipment that participates in this regulating control scheme.

    RegulationSchedule

    RegulationSchedule Schedule for this regulating control.

    Terminal

    Terminal The terminal associated with this regulating control. The terminal is associated instead of a node, since the terminal could connect into either a topological node or a connectivity node. Sometimes it is useful to model regulation at a terminal of a bus bar object.

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 PowerSystemResource: PowerSystemResource
  5. val ProtectiveActionRegulation: List[String]
  6. val RegulatingCondEq: List[String]
  7. val RegulationSchedule: List[String]
  8. val Terminal: String
  9. 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
  10. def anyNull: Boolean
    Definition Classes
    Row
  11. def apply(i: Int): Any
    Definition Classes
    Row
  12. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  13. def baseclass: String

    This class name.

    This class name.

    returns

    the class name without the package prefixes

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

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

  21. val enabled: Boolean
  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
    RegulatingControlElement
  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
    RegulatingControlElement
  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. def hashCode(): Int
    Definition Classes
    Row → AnyRef → Any
  51. 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
  52. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  53. def isNullAt(i: Int): Boolean
    Definition Classes
    Row
  54. def json: String
    Definition Classes
    Row
    Annotations
    @Unstable()
  55. 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
  56. 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
  57. val maxAllowedTargetValue: Double
  58. val minAllowedTargetValue: Double
  59. def mkString(start: String, sep: String, end: String): String
    Definition Classes
    Row
  60. def mkString(sep: String): String
    Definition Classes
    Row
  61. def mkString: String
    Definition Classes
    Row
  62. val mode: String
  63. val monitoredPhase: String
  64. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  65. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  66. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  67. def prettyJson: String
    Definition Classes
    Row
    Annotations
    @Unstable()
  68. def schema: StructType
    Definition Classes
    Row
  69. def size: Int
    Definition Classes
    Row
  70. def sup: PowerSystemResource

    Return the superclass object.

    Return the superclass object.

    returns

    The typed superclass nested object.

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