Packages

final case class Switch(ConductingEquipment: ConductingEquipment = null, locked: Boolean = false, normalOpen: Boolean = false, open: Boolean = false, ratedCurrent: Double = 0.0, retained: Boolean = false, switchOnCount: Int = 0, switchOnDate: String = null, CompositeSwitch: String = null, ConnectDisconnectFunctions: List[String] = null, SvSwitch: List[String] = null, SwitchAction: String = null, SwitchPhase: List[String] = null, SwitchSchedules: List[String] = null) extends Element with Product with Serializable

A generic device designed to close, or open, or both, one or more electric circuits.

All switches are two terminal devices including grounding switches. The ACDCTerminal.connected at the two sides of the switch shall not be considered for assessing switch connectivity, i.e. only Switch.open, .normalOpen and .locked are relevant.

ConductingEquipment

ConductingEquipment Reference to the superclass object.

locked

If true, the switch is locked. The resulting switch state is a combination of locked and Switch.open attributes as follows:

  • locked=true and Switch.open=true. The resulting state is open and locked;
  • locked=false and Switch.open=true. The resulting state is open;
  • locked=false and Switch.open=false. The resulting state is closed.
normalOpen

The attribute is used in cases when no Measurement for the status value is present. If the Switch has a status measurement the Discrete.normalValue is expected to match with the Switch.normalOpen.

open

The attribute tells if the switch is considered open when used as input to topology processing.

ratedCurrent

The maximum continuous current carrying capacity in amps governed by the device material and construction. The attribute shall be a positive value.

retained

Branch is retained in the topological solution. The flow through retained switches will normally be calculated in power flow.

switchOnCount

The switch on count since the switch was last reset or initialized.

switchOnDate

The date and time when the switch was last switched on.

CompositeSwitch

CompositeSwitch Composite switch to which this Switch belongs.

ConnectDisconnectFunctions

ConnectDisconnectFunction undocumented

SvSwitch

SvSwitch The switch state associated with the switch.

SwitchAction

SwitchAction Action changing status of this switch.

SwitchPhase

SwitchPhase The individual switch phases for the switch.

SwitchSchedules

SwitchSchedule A Switch can be associated with SwitchSchedules.

Linear Supertypes
Element, Product, Equals, Cloneable, Cloneable, Row, Serializable, Serializable, AnyRef, Any
Ordering
  1. Grouped
  2. Alphabetic
  3. By Inheritance
Inherited
  1. Switch
  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 Switch(ConductingEquipment: ConductingEquipment = null, locked: Boolean = false, normalOpen: Boolean = false, open: Boolean = false, ratedCurrent: Double = 0.0, retained: Boolean = false, switchOnCount: Int = 0, switchOnDate: String = null, CompositeSwitch: String = null, ConnectDisconnectFunctions: List[String] = null, SvSwitch: List[String] = null, SwitchAction: String = null, SwitchPhase: List[String] = null, SwitchSchedules: List[String] = null)

    ConductingEquipment

    ConductingEquipment Reference to the superclass object.

    locked

    If true, the switch is locked. The resulting switch state is a combination of locked and Switch.open attributes as follows:

    • locked=true and Switch.open=true. The resulting state is open and locked;
    • locked=false and Switch.open=true. The resulting state is open;
    • locked=false and Switch.open=false. The resulting state is closed.
    normalOpen

    The attribute is used in cases when no Measurement for the status value is present. If the Switch has a status measurement the Discrete.normalValue is expected to match with the Switch.normalOpen.

    open

    The attribute tells if the switch is considered open when used as input to topology processing.

    ratedCurrent

    The maximum continuous current carrying capacity in amps governed by the device material and construction. The attribute shall be a positive value.

    retained

    Branch is retained in the topological solution. The flow through retained switches will normally be calculated in power flow.

    switchOnCount

    The switch on count since the switch was last reset or initialized.

    switchOnDate

    The date and time when the switch was last switched on.

    CompositeSwitch

    CompositeSwitch Composite switch to which this Switch belongs.

    ConnectDisconnectFunctions

    ConnectDisconnectFunction undocumented

    SvSwitch

    SvSwitch The switch state associated with the switch.

    SwitchAction

    SwitchAction Action changing status of this switch.

    SwitchPhase

    SwitchPhase The individual switch phases for the switch.

    SwitchSchedules

    SwitchSchedule A Switch can be associated with SwitchSchedules.

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 CompositeSwitch: String
  5. val ConductingEquipment: ConductingEquipment
  6. val ConnectDisconnectFunctions: List[String]
  7. val SvSwitch: List[String]
  8. val SwitchAction: String
  9. val SwitchPhase: List[String]
  10. val SwitchSchedules: List[String]
  11. 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
  12. def anyNull: Boolean
    Definition Classes
    Row
  13. def apply(i: Int): Any
    Definition Classes
    Row
  14. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  15. def baseclass: String

    This class name.

    This class name.

    returns

    the class name without the package prefixes

    Definition Classes
    Element
  16. 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
  17. 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
  18. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  19. 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
    Switch → Row
  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
    SwitchElement
  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
    SwitchElement
  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. val locked: Boolean
  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. val normalOpen: Boolean
  63. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  64. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  65. val open: Boolean
  66. def prettyJson: String
    Definition Classes
    Row
    Annotations
    @Unstable()
  67. val ratedCurrent: Double
  68. val retained: Boolean
  69. def schema: StructType
    Definition Classes
    Row
  70. def size: Int
    Definition Classes
    Row
  71. def sup: ConductingEquipment

    Return the superclass object.

    Return the superclass object.

    returns

    The typed superclass nested object.

    Definition Classes
    SwitchElement
  72. val switchOnCount: Int
  73. val switchOnDate: String
  74. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  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