final case class UsagePoint(IdentifiedObject: IdentifiedObject = null, amiBillingReady: String = null, checkBilling: Boolean = false, connectionCategory: String = null, connectionState: String = null, disconnectionMethod: String = null, estimatedLoad: Double = 0.0, grounded: Boolean = false, isSdp: Boolean = false, isVirtual: Boolean = false, minimalUsageExpected: Boolean = false, nominalServiceVoltage: Double = 0.0, outageRegion: String = null, phaseCode: String = null, phaseCount: Int = 0, physicalConnectionCapacity: String = null, ratedCurrent: Double = 0.0, ratedPower: Double = 0.0, readCycle: String = null, readRoute: String = null, serviceDeliveryRemark: String = null, servicePriority: String = null, ConfigurationEvents: List[String] = null, CustomerAgreement: String = null, EndDeviceControls: List[String] = null, EndDeviceEvents: List[String] = null, EndDevices: List[String] = null, EnvironmentalMonitoringStation: String = null, Equipments: List[String] = null, MeterReadings: List[String] = null, MeterServiceWorkTasks: List[String] = null, MetrologyRequirements: List[String] = null, Outage: List[String] = null, PricingStructures: List[String] = null, Register: List[String] = null, ServiceCategory: String = null, ServiceLocation: String = null, ServiceMultipliers: List[String] = null, ServiceSupplier: String = null, UsagePointGroups: List[String] = null, UsagePointLocation: String = null) extends Element with Product with Serializable
Logical or physical point in the network to which readings or events may be attributed.
Used at the place where a physical or virtual meter may be located; however, it is not required that a meter be present.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- amiBillingReady
Tracks the lifecycle of the metering installation at a usage point with respect to readiness for billing via advanced metering infrastructure reads.
- checkBilling
True if as a result of an inspection or otherwise, there is a reason to suspect that a previous billing may have been performed with erroneous data. Value should be reset once this potential discrepancy has been resolved.
- connectionCategory
A code used to specify the connection category, e.g., low voltage or low pressure, where the usage point is defined.
- connectionState
State of the usage point with respect to connection to the network.
- disconnectionMethod
Is an indication of how the usage point is physically connected or disconnected.
- estimatedLoad
Estimated load.
- grounded
True if grounded.
- isSdp
If true, this usage point is a service delivery point, i.e., a usage point where the ownership of the service changes hands.
- isVirtual
If true, this usage point is virtual, i.e., no physical location exists in the network where a meter could be located to collect the meter readings. For example, one may define a virtual usage point to serve as an aggregation of usage for all of a company's premises distributed widely across the distribution territory. Otherwise, the usage point is physical, i.e., there is a logical point in the network where a meter could be located to collect meter readings.
- minimalUsageExpected
If true, minimal or zero usage is expected at this usage point for situations such as premises vacancy, logical or physical disconnect. It is used for readings validation and estimation.
- nominalServiceVoltage
Nominal service voltage.
- outageRegion
Outage region in which this usage point is located.
- phaseCode
Phase code. Number of wires and specific nominal phases can be deduced from enumeration literal values. For example, ABCN is three-phase, four-wire, s12n (splitSecondary12N) is single-phase, three-wire, and s1n and s2n are single-phase, two-wire.
- phaseCount
Number of potential phases the Usage Point supports, typically 0, 1 or 3.
- physicalConnectionCapacity
Quantitative information about the maximum physical capacity of the connection for the usage point.
- ratedCurrent
Current flow that this usage point is configured to deliver.
- ratedPower
Active power that this usage point is configured to deliver.
- readCycle
Cycle day on which the meter for this usage point will normally be read. Usually correlated with the billing cycle.
- readRoute
Identifier of the route to which this usage point is assigned for purposes of meter reading. Typically used to configure hand held meter reading systems prior to collection of reads.
- serviceDeliveryRemark
Remarks about this usage point, for example the reason for it being rated with a non-nominal priority.
- servicePriority
Priority of service for this usage point. Note that usage points at the same service location can have different priorities.
- ConfigurationEvents
ConfigurationEvent All configuration events created for this usage point.
- CustomerAgreement
CustomerAgreement Customer agreement regulating this service delivery point.
- EndDeviceControls
EndDeviceControl All end device controls sending commands to this usage point.
- EndDeviceEvents
EndDeviceEvent All end device events reported for this usage point.
- EndDevices
EndDevice All end devices at this usage point.
- EnvironmentalMonitoringStation
EnvironmentalMonitoringStation undocumented
- Equipments
Equipment All equipment connecting this usage point to the electrical grid.
- MeterReadings
MeterReading All meter readings obtained from this usage point.
- MeterServiceWorkTasks
MeterWorkTask All meter service work tasks at this usage point.
- MetrologyRequirements
MetrologyRequirement All metrology requirements for this usage point.
- Outage
Outage All outages at this usage point.
- PricingStructures
PricingStructure All pricing structures applicable to this service delivery point (with prepayment meter running as a stand-alone device, with no CustomerAgreement or Customer).
- Register
Register undocumented
- ServiceCategory
ServiceCategory Service category delivered by this usage point.
- ServiceLocation
ServiceLocation Service location where the service delivered by this usage point is consumed.
- ServiceMultipliers
ServiceMultiplier All multipliers applied at this usage point.
- ServiceSupplier
ServiceSupplier ServiceSupplier (utility) utilising this usage point to deliver a service.
- UsagePointGroups
UsagePointGroup All groups to which this usage point belongs.
- UsagePointLocation
UsagePointLocation Location of this usage point.
- Grouped
- Alphabetic
- By Inheritance
- UsagePoint
- Element
- Product
- Equals
- Cloneable
- Cloneable
- Row
- Serializable
- Serializable
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
-
new
UsagePoint(IdentifiedObject: IdentifiedObject = null, amiBillingReady: String = null, checkBilling: Boolean = false, connectionCategory: String = null, connectionState: String = null, disconnectionMethod: String = null, estimatedLoad: Double = 0.0, grounded: Boolean = false, isSdp: Boolean = false, isVirtual: Boolean = false, minimalUsageExpected: Boolean = false, nominalServiceVoltage: Double = 0.0, outageRegion: String = null, phaseCode: String = null, phaseCount: Int = 0, physicalConnectionCapacity: String = null, ratedCurrent: Double = 0.0, ratedPower: Double = 0.0, readCycle: String = null, readRoute: String = null, serviceDeliveryRemark: String = null, servicePriority: String = null, ConfigurationEvents: List[String] = null, CustomerAgreement: String = null, EndDeviceControls: List[String] = null, EndDeviceEvents: List[String] = null, EndDevices: List[String] = null, EnvironmentalMonitoringStation: String = null, Equipments: List[String] = null, MeterReadings: List[String] = null, MeterServiceWorkTasks: List[String] = null, MetrologyRequirements: List[String] = null, Outage: List[String] = null, PricingStructures: List[String] = null, Register: List[String] = null, ServiceCategory: String = null, ServiceLocation: String = null, ServiceMultipliers: List[String] = null, ServiceSupplier: String = null, UsagePointGroups: List[String] = null, UsagePointLocation: String = null)
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- amiBillingReady
Tracks the lifecycle of the metering installation at a usage point with respect to readiness for billing via advanced metering infrastructure reads.
- checkBilling
True if as a result of an inspection or otherwise, there is a reason to suspect that a previous billing may have been performed with erroneous data. Value should be reset once this potential discrepancy has been resolved.
- connectionCategory
A code used to specify the connection category, e.g., low voltage or low pressure, where the usage point is defined.
- connectionState
State of the usage point with respect to connection to the network.
- disconnectionMethod
Is an indication of how the usage point is physically connected or disconnected.
- estimatedLoad
Estimated load.
- grounded
True if grounded.
- isSdp
If true, this usage point is a service delivery point, i.e., a usage point where the ownership of the service changes hands.
- isVirtual
If true, this usage point is virtual, i.e., no physical location exists in the network where a meter could be located to collect the meter readings. For example, one may define a virtual usage point to serve as an aggregation of usage for all of a company's premises distributed widely across the distribution territory. Otherwise, the usage point is physical, i.e., there is a logical point in the network where a meter could be located to collect meter readings.
- minimalUsageExpected
If true, minimal or zero usage is expected at this usage point for situations such as premises vacancy, logical or physical disconnect. It is used for readings validation and estimation.
- nominalServiceVoltage
Nominal service voltage.
- outageRegion
Outage region in which this usage point is located.
- phaseCode
Phase code. Number of wires and specific nominal phases can be deduced from enumeration literal values. For example, ABCN is three-phase, four-wire, s12n (splitSecondary12N) is single-phase, three-wire, and s1n and s2n are single-phase, two-wire.
- phaseCount
Number of potential phases the Usage Point supports, typically 0, 1 or 3.
- physicalConnectionCapacity
Quantitative information about the maximum physical capacity of the connection for the usage point.
- ratedCurrent
Current flow that this usage point is configured to deliver.
- ratedPower
Active power that this usage point is configured to deliver.
- readCycle
Cycle day on which the meter for this usage point will normally be read. Usually correlated with the billing cycle.
- readRoute
Identifier of the route to which this usage point is assigned for purposes of meter reading. Typically used to configure hand held meter reading systems prior to collection of reads.
- serviceDeliveryRemark
Remarks about this usage point, for example the reason for it being rated with a non-nominal priority.
- servicePriority
Priority of service for this usage point. Note that usage points at the same service location can have different priorities.
- ConfigurationEvents
ConfigurationEvent All configuration events created for this usage point.
- CustomerAgreement
CustomerAgreement Customer agreement regulating this service delivery point.
- EndDeviceControls
EndDeviceControl All end device controls sending commands to this usage point.
- EndDeviceEvents
EndDeviceEvent All end device events reported for this usage point.
- EndDevices
EndDevice All end devices at this usage point.
- EnvironmentalMonitoringStation
EnvironmentalMonitoringStation undocumented
- Equipments
Equipment All equipment connecting this usage point to the electrical grid.
- MeterReadings
MeterReading All meter readings obtained from this usage point.
- MeterServiceWorkTasks
MeterWorkTask All meter service work tasks at this usage point.
- MetrologyRequirements
MetrologyRequirement All metrology requirements for this usage point.
- Outage
Outage All outages at this usage point.
- PricingStructures
PricingStructure All pricing structures applicable to this service delivery point (with prepayment meter running as a stand-alone device, with no CustomerAgreement or Customer).
- Register
Register undocumented
- ServiceCategory
ServiceCategory Service category delivered by this usage point.
- ServiceLocation
ServiceLocation Service location where the service delivered by this usage point is consumed.
- ServiceMultipliers
ServiceMultiplier All multipliers applied at this usage point.
- ServiceSupplier
ServiceSupplier ServiceSupplier (utility) utilising this usage point to deliver a service.
- UsagePointGroups
UsagePointGroup All groups to which this usage point belongs.
- UsagePointLocation
UsagePointLocation Location of this usage point.
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 ConfigurationEvents: List[String]
- val CustomerAgreement: String
- val EndDeviceControls: List[String]
- val EndDeviceEvents: List[String]
- val EndDevices: List[String]
- val EnvironmentalMonitoringStation: String
- val Equipments: List[String]
- val IdentifiedObject: IdentifiedObject
- val MeterReadings: List[String]
- val MeterServiceWorkTasks: List[String]
- val MetrologyRequirements: List[String]
- val Outage: List[String]
- val PricingStructures: List[String]
- val Register: List[String]
- val ServiceCategory: String
- val ServiceLocation: String
- val ServiceMultipliers: List[String]
- val ServiceSupplier: String
- val UsagePointGroups: List[String]
- val UsagePointLocation: String
-
def
about: Boolean
Flag for rdf:about elements.
Flag for rdf:about elements.
- returns
trueif this is an rdf:about element,falseotherwise.
- Definition Classes
- Element
- val amiBillingReady: 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
- val checkBilling: Boolean
-
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 connectionCategory: String
- val connectionState: 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
- UsagePoint → Row
- val disconnectionMethod: String
-
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 estimatedLoad: Double
-
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
- UsagePoint → 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
- UsagePoint → 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
nullif 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
- val grounded: Boolean
-
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
- val isSdp: Boolean
- val isVirtual: Boolean
-
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
trueif the field was parsed,falseotherwise.
- Definition Classes
- Element
- val minimalUsageExpected: Boolean
-
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 nominalServiceVoltage: Double
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- val outageRegion: String
- val phaseCode: String
- val phaseCount: Int
- val physicalConnectionCapacity: String
-
def
prettyJson: String
- Definition Classes
- Row
- Annotations
- @Unstable()
- val ratedCurrent: Double
- val ratedPower: Double
- val readCycle: String
- val readRoute: String
-
def
schema: StructType
- Definition Classes
- Row
- val serviceDeliveryRemark: String
- val servicePriority: String
-
def
size: Int
- Definition Classes
- Row
-
def
sup: IdentifiedObject
Return the superclass object.
Return the superclass object.
- returns
The typed superclass nested object.
- Definition Classes
- UsagePoint → 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
-
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.