Packages

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.

Linear Supertypes
Element, Product, Equals, Cloneable, Cloneable, Row, Serializable, Serializable, AnyRef, Any
Ordering
  1. Grouped
  2. Alphabetic
  3. By Inheritance
Inherited
  1. EndDeviceControl
  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 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

  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 EndDeviceAction: String
  5. val EndDeviceControlType: String
  6. val EndDeviceGroups: List[String]
  7. val EndDevices: List[String]
  8. val IdentifiedObject: IdentifiedObject
  9. val UsagePointGroups: List[String]
  10. val UsagePoints: 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
    EndDeviceControl → Row
  20. val drProgramLevel: Int
  21. val drProgramMandatory: Boolean
  22. 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"/>

  23. 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>

  24. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  25. def equals(o: Any): Boolean
    Definition Classes
    Row → AnyRef → Any
  26. 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
    EndDeviceControlElement
  27. 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
    EndDeviceControlElement
  28. def fieldIndex(name: String): Int
    Definition Classes
    Row
  29. 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
  30. def getAs[T](fieldName: String): T
    Definition Classes
    Row
  31. def getAs[T](i: Int): T
    Definition Classes
    Row
  32. def getBoolean(i: Int): Boolean
    Definition Classes
    Row
  33. def getByte(i: Int): Byte
    Definition Classes
    Row
  34. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  35. def getDate(i: Int): Date
    Definition Classes
    Row
  36. def getDecimal(i: Int): BigDecimal
    Definition Classes
    Row
  37. def getDouble(i: Int): Double
    Definition Classes
    Row
  38. def getFloat(i: Int): Float
    Definition Classes
    Row
  39. def getInstant(i: Int): Instant
    Definition Classes
    Row
  40. def getInt(i: Int): Int
    Definition Classes
    Row
  41. def getJavaMap[K, V](i: Int): Map[K, V]
    Definition Classes
    Row
  42. def getList[T](i: Int): List[T]
    Definition Classes
    Row
  43. def getLocalDate(i: Int): LocalDate
    Definition Classes
    Row
  44. def getLong(i: Int): Long
    Definition Classes
    Row
  45. def getMap[K, V](i: Int): Map[K, V]
    Definition Classes
    Row
  46. def getSeq[T](i: Int): Seq[T]
    Definition Classes
    Row
  47. def getShort(i: Int): Short
    Definition Classes
    Row
  48. def getString(i: Int): String
    Definition Classes
    Row
  49. def getStruct(i: Int): Row
    Definition Classes
    Row
  50. def getTimestamp(i: Int): Timestamp
    Definition Classes
    Row
  51. def getValuesMap[T](fieldNames: Seq[String]): Map[String, T]
    Definition Classes
    Row
  52. def hashCode(): Int
    Definition Classes
    Row → AnyRef → Any
  53. 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
  54. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  55. def isNullAt(i: Int): Boolean
    Definition Classes
    Row
  56. val issuerID: String
  57. val issuerTrackingID: String
  58. def json: String
    Definition Classes
    Row
    Annotations
    @Unstable()
  59. 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
  60. 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
  61. def mkString(start: String, sep: String, end: String): String
    Definition Classes
    Row
  62. def mkString(sep: String): String
    Definition Classes
    Row
  63. def mkString: String
    Definition Classes
    Row
  64. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  65. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  66. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  67. def prettyJson: String
    Definition Classes
    Row
    Annotations
    @Unstable()
  68. val priceSignal: String
  69. val primaryDeviceTiming: String
  70. val reason: String
  71. val scheduledInterval: String
  72. def schema: StructType
    Definition Classes
    Row
  73. val secondaryDeviceTiming: String
  74. def size: Int
    Definition Classes
    Row
  75. def sup: IdentifiedObject

    Return the superclass object.

    Return the superclass object.

    returns

    The typed superclass nested object.

    Definition Classes
    EndDeviceControlElement
  76. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  77. def toSeq: Seq[Any]
    Definition Classes
    Row
  78. def toString(): String
    Definition Classes
    Row → AnyRef → Any
  79. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  80. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  81. 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