final case class EndDeviceControl(IdentifiedObject: IdentifiedObject = null, drProgramLevel: Int = 0, drProgramMandatory: Boolean = false, issuerID: String = null, issuerTrackingID: String = null, priceSignal: String = null, primaryDeviceTiming: String = null, reason: String = null, scheduledInterval: String = null, secondaryDeviceTiming: String = null, EndDeviceAction: String = null, EndDeviceControlType: String = null, EndDeviceGroups: List[String] = null, EndDevices: List[String] = null, UsagePointGroups: List[String] = null, UsagePoints: List[String] = null) extends Element with Product with Serializable
Instructs an end device (or an end device group) to perform a specified action.
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- drProgramLevel
Level of a demand response program request, where 0=emergency. Note: Attribute is not defined on DemandResponseProgram as it is not its inherent property (it serves to control it).
- drProgramMandatory
Whether a demand response program request is mandatory. Note: Attribute is not defined on DemandResponseProgram as it is not its inherent property (it serves to control it).
- issuerID
Unique identifier of the business entity originating an end device control.
- issuerTrackingID
Identifier assigned by the initiator (e.g. retail electric provider) of an end device control action to uniquely identify the demand response event, text message, or other subject of the control action. Can be used when cancelling an event or text message request or to identify the originating event or text message in a consequential end device event.
- priceSignal
(if applicable) Price signal used as parameter for this end device control.
- primaryDeviceTiming
EndDeviceTiming Timing for the control actions performed on the device identified in the end device control.
- reason
Reason for the control action that allows to determine how to continue processing. For example, disconnect meter command may require different processing by the receiving system if it has been issued for a network-related reason (protection) or for a payment-related reason.
- scheduledInterval
(if control has scheduled duration) Date and time interval the control has been scheduled to execute within.
- secondaryDeviceTiming
EndDeviceTiming Timing for the control actions performed by devices that are responding to event related information sent to the primary device indicated in the end device control. For example, load control actions performed by a PAN device in response to demand response event information sent to a PAN gateway server.
- EndDeviceAction
EndDeviceAction End device action issued by this end device control.
- EndDeviceControlType
EndDeviceControlType Type of this end device control.
- EndDeviceGroups
EndDeviceGroup All end device groups receiving commands from this end device control.
- EndDevices
EndDevice All end devices receiving commands from this end device control.
- UsagePointGroups
UsagePointGroup All usage point groups receiving commands from this end device control.
- UsagePoints
UsagePoint All usage points receiving commands from this end device control.
- Grouped
- Alphabetic
- By Inheritance
- EndDeviceControl
- Element
- Product
- Equals
- Cloneable
- Cloneable
- Row
- Serializable
- Serializable
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
-
new
EndDeviceControl(IdentifiedObject: IdentifiedObject = null, drProgramLevel: Int = 0, drProgramMandatory: Boolean = false, issuerID: String = null, issuerTrackingID: String = null, priceSignal: String = null, primaryDeviceTiming: String = null, reason: String = null, scheduledInterval: String = null, secondaryDeviceTiming: String = null, EndDeviceAction: String = null, EndDeviceControlType: String = null, EndDeviceGroups: List[String] = null, EndDevices: List[String] = null, UsagePointGroups: List[String] = null, UsagePoints: List[String] = null)
- IdentifiedObject
IdentifiedObject Reference to the superclass object.
- drProgramLevel
Level of a demand response program request, where 0=emergency. Note: Attribute is not defined on DemandResponseProgram as it is not its inherent property (it serves to control it).
- drProgramMandatory
Whether a demand response program request is mandatory. Note: Attribute is not defined on DemandResponseProgram as it is not its inherent property (it serves to control it).
- issuerID
Unique identifier of the business entity originating an end device control.
- issuerTrackingID
Identifier assigned by the initiator (e.g. retail electric provider) of an end device control action to uniquely identify the demand response event, text message, or other subject of the control action. Can be used when cancelling an event or text message request or to identify the originating event or text message in a consequential end device event.
- priceSignal
(if applicable) Price signal used as parameter for this end device control.
- primaryDeviceTiming
EndDeviceTiming Timing for the control actions performed on the device identified in the end device control.
- reason
Reason for the control action that allows to determine how to continue processing. For example, disconnect meter command may require different processing by the receiving system if it has been issued for a network-related reason (protection) or for a payment-related reason.
- scheduledInterval
(if control has scheduled duration) Date and time interval the control has been scheduled to execute within.
- secondaryDeviceTiming
EndDeviceTiming Timing for the control actions performed by devices that are responding to event related information sent to the primary device indicated in the end device control. For example, load control actions performed by a PAN device in response to demand response event information sent to a PAN gateway server.
- EndDeviceAction
EndDeviceAction End device action issued by this end device control.
- EndDeviceControlType
EndDeviceControlType Type of this end device control.
- EndDeviceGroups
EndDeviceGroup All end device groups receiving commands from this end device control.
- EndDevices
EndDevice All end devices receiving commands from this end device control.
- UsagePointGroups
UsagePointGroup All usage point groups receiving commands from this end device control.
- UsagePoints
UsagePoint All usage points receiving commands from this end device control.
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 EndDeviceAction: String
- val EndDeviceControlType: String
- val EndDeviceGroups: List[String]
- val EndDevices: List[String]
- val IdentifiedObject: IdentifiedObject
- val UsagePointGroups: List[String]
- val UsagePoints: 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
- EndDeviceControl → Row
- val drProgramLevel: Int
- val drProgramMandatory: Boolean
-
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.
Return a string containing this object as XML.
- returns
The XML corresponding to this object.
- Definition Classes
- EndDeviceControl → 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
- EndDeviceControl → 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
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
- val issuerID: String
- val issuerTrackingID: String
-
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
-
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()
-
def
prettyJson: String
- Definition Classes
- Row
- Annotations
- @Unstable()
- val priceSignal: String
- val primaryDeviceTiming: String
- val reason: String
- val scheduledInterval: String
-
def
schema: StructType
- Definition Classes
- Row
- val secondaryDeviceTiming: 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
- EndDeviceControl → 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.