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.
- Grouped
- Alphabetic
- By Inheritance
- Switch
- Element
- Product
- Equals
- Cloneable
- Cloneable
- Row
- Serializable
- Serializable
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
-
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
-
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 CompositeSwitch: String
- val ConductingEquipment: ConductingEquipment
- val ConnectDisconnectFunctions: List[String]
- val SvSwitch: List[String]
- val SwitchAction: String
- val SwitchPhase: List[String]
- val SwitchSchedules: 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
- Switch → 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.
-
def
export_fields: String
Return a string containing the fields of this object suitable for inclusion in an XML object.
-
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
- val locked: Boolean
-
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 normalOpen: Boolean
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- val open: Boolean
-
def
prettyJson: String
- Definition Classes
- Row
- Annotations
- @Unstable()
- val ratedCurrent: Double
- val retained: Boolean
-
def
schema: StructType
- Definition Classes
- Row
-
def
size: Int
- Definition Classes
- Row
-
def
sup: ConductingEquipment
Return the superclass object.
- val switchOnCount: Int
- val switchOnDate: String
-
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.