final case class Outage(Document: Document = null, actualPeriod: String = null, communityDescriptor: String = null, customersRestored: Int = 0, estimatedPeriod: String = null, metersAffected: Int = 0, originalCustomersServed: Int = 0, originalMetersAffected: Int = 0, outageKind: String = null, statusKind: String = null, summary: String = null, utilityDisclaimer: String = null, Crew: List[String] = null, DeEnergizedUsagePoint: List[String] = null, EnergizedUsagePoint: List[String] = null, Equipments: List[String] = null, EstimatedRestorationTime: String = null, Faults: List[String] = null, Incident: List[String] = null, OutageArea: List[String] = null, OutageIsolationEquipment: List[String] = null, PlannedSwitchActions: List[String] = null, SwitchingPlans: List[String] = null) extends Element with Product with Serializable
Document describing details of an active or planned outage in a part of the electrical network.
A non-planned outage may be created upon: - a breaker trip, - a fault indicator status change, - a meter event indicating customer outage, - a reception of one or more customer trouble calls, or - an operator command, reflecting information obtained from the field crew. Outage restoration may be performed using a switching plan which complements the outage information with detailed switching activities, including the relationship to the crew and work. A planned outage may be created upon: - a request for service, maintenance or construction work in the field, or - an operator-defined outage for what-if/contingency network analysis.
- Document
Document Reference to the superclass object.
- actualPeriod
Actual outage period; end of the period corresponds to the actual restoration time.
- communityDescriptor
a name to denote the community - this could be a name or a code of some kind.
- customersRestored
number of customers that have been restored in the area.
- estimatedPeriod
Estimated outage period for a planned outage. The start of the period is the start of the planned outage and the end of the period corresponds to the end of the planned outage.
- metersAffected
The updated number of meters affected by the outage as reported by the OMS within the utility. It is assumed this number will be updated repeatedly until the full outage is resolved.
- originalCustomersServed
the total number of customers that are served in the area (both outaged and not outaged).
- originalMetersAffected
The original number of meters that were affected as reported by the OMS within the utility. That is, this is the total number of meters that were out at the beginning of the outage.
- outageKind
Defines if the outage has been verified or is only estimated
- statusKind
defines the status of the crew as in dispatched or arrived, etc.
- summary
ServicePointOutageSummary Summary counts of service points (customers) affected by this outage.
- utilityDisclaimer
This contains an disclaimers the utility would like to place on the data provided to any stakeholder. This may be different for different stakeholders. This should possibly be an attribute under the Organization class but it is placed here for now.
- Crew
Crew undocumented
- DeEnergizedUsagePoint
UsagePoint all deenergized useage points associated with the outage.
- EnergizedUsagePoint
UsagePoint All energized usage points associated with this outage.
- Equipments
Equipment All equipments associated with this outage.
- EstimatedRestorationTime
EstimatedRestorationTime undocumented
- Faults
Fault All faults involved in this outage.
- Incident
Incident Incident reported in trouble call that results in this outage.
- OutageArea
OutageArea undocumented
- OutageIsolationEquipment
ConductingEquipment undocumented
- PlannedSwitchActions
SwitchAction All switch actions to apply within the scope of this planned outage. Each such action groups switches to which the action is to apply in order to produce the desired network state considered as outage.
- SwitchingPlans
SwitchingPlan All switching plans that lead to supply restoration due to this outage. Only one will be retained for execution.
- Grouped
- Alphabetic
- By Inheritance
- Outage
- Element
- Product
- Equals
- Cloneable
- Cloneable
- Row
- Serializable
- Serializable
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
-
new
Outage(Document: Document = null, actualPeriod: String = null, communityDescriptor: String = null, customersRestored: Int = 0, estimatedPeriod: String = null, metersAffected: Int = 0, originalCustomersServed: Int = 0, originalMetersAffected: Int = 0, outageKind: String = null, statusKind: String = null, summary: String = null, utilityDisclaimer: String = null, Crew: List[String] = null, DeEnergizedUsagePoint: List[String] = null, EnergizedUsagePoint: List[String] = null, Equipments: List[String] = null, EstimatedRestorationTime: String = null, Faults: List[String] = null, Incident: List[String] = null, OutageArea: List[String] = null, OutageIsolationEquipment: List[String] = null, PlannedSwitchActions: List[String] = null, SwitchingPlans: List[String] = null)
- Document
Document Reference to the superclass object.
- actualPeriod
Actual outage period; end of the period corresponds to the actual restoration time.
- communityDescriptor
a name to denote the community - this could be a name or a code of some kind.
- customersRestored
number of customers that have been restored in the area.
- estimatedPeriod
Estimated outage period for a planned outage. The start of the period is the start of the planned outage and the end of the period corresponds to the end of the planned outage.
- metersAffected
The updated number of meters affected by the outage as reported by the OMS within the utility. It is assumed this number will be updated repeatedly until the full outage is resolved.
- originalCustomersServed
the total number of customers that are served in the area (both outaged and not outaged).
- originalMetersAffected
The original number of meters that were affected as reported by the OMS within the utility. That is, this is the total number of meters that were out at the beginning of the outage.
- outageKind
Defines if the outage has been verified or is only estimated
- statusKind
defines the status of the crew as in dispatched or arrived, etc.
- summary
ServicePointOutageSummary Summary counts of service points (customers) affected by this outage.
- utilityDisclaimer
This contains an disclaimers the utility would like to place on the data provided to any stakeholder. This may be different for different stakeholders. This should possibly be an attribute under the Organization class but it is placed here for now.
- Crew
Crew undocumented
- DeEnergizedUsagePoint
UsagePoint all deenergized useage points associated with the outage.
- EnergizedUsagePoint
UsagePoint All energized usage points associated with this outage.
- Equipments
Equipment All equipments associated with this outage.
- EstimatedRestorationTime
EstimatedRestorationTime undocumented
- Faults
Fault All faults involved in this outage.
- Incident
Incident Incident reported in trouble call that results in this outage.
- OutageArea
OutageArea undocumented
- OutageIsolationEquipment
ConductingEquipment undocumented
- PlannedSwitchActions
SwitchAction All switch actions to apply within the scope of this planned outage. Each such action groups switches to which the action is to apply in order to produce the desired network state considered as outage.
- SwitchingPlans
SwitchingPlan All switching plans that lead to supply restoration due to this outage. Only one will be retained for execution.
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 Crew: List[String]
- val DeEnergizedUsagePoint: List[String]
- val Document: Document
- val EnergizedUsagePoint: List[String]
- val Equipments: List[String]
- val EstimatedRestorationTime: String
- val Faults: List[String]
- val Incident: List[String]
- val OutageArea: List[String]
- val OutageIsolationEquipment: List[String]
- val PlannedSwitchActions: List[String]
- val SwitchingPlans: 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
- val actualPeriod: String
-
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()
- val communityDescriptor: String
-
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
- Outage → Row
- val customersRestored: Int
-
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
- val estimatedPeriod: String
-
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
-
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
- val metersAffected: Int
-
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
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- val originalCustomersServed: Int
- val originalMetersAffected: Int
- val outageKind: String
-
def
prettyJson: String
- Definition Classes
- Row
- Annotations
- @Unstable()
-
def
schema: StructType
- Definition Classes
- Row
-
def
size: Int
- Definition Classes
- Row
- val statusKind: String
- val summary: String
-
def
sup: Document
Return the superclass object.
-
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 utilityDisclaimer: 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.