Packages

final case class PanDemandResponse(EndDeviceAction: EndDeviceAction = null, appliance: String = null, avgLoadAdjustment: Double = 0.0, cancelControlMode: String = null, cancelDateTime: String = null, cancelNow: Boolean = false, coolingOffset: Double = 0.0, coolingSetpoint: Double = 0.0, criticalityLevel: String = null, dutyCycle: Double = 0.0, enrollmentGroup: String = null, heatingOffset: Double = 0.0, heatingSetpoint: Double = 0.0) extends Element with Product with Serializable

PAN control used to issue action/command to PAN devices during a demand response/load control event.

EndDeviceAction

EndDeviceAction Reference to the superclass object.

appliance

ControlledAppliance Appliance being controlled.

avgLoadAdjustment

Used to define a maximum energy usage limit as a percentage of the client implementations specific average energy usage. The load adjustment percentage is added to 100% creating a percentage limit applied to the client implementations specific average energy usage. A -10% load adjustment percentage will establish an energy usage limit equal to 90% of the client implementations specific average energy usage. Each load adjustment percentage is referenced to the client implementations specific average energy usage. There are no cumulative effects. The range of this field is -100% to +100% with a resolution of 1. A -100% value equals a total load shed. A +100% value will limit the energy usage to the client implementations specific average energy usage.

cancelControlMode

Encoding of cancel control.

cancelDateTime

Timestamp when a canceling of the event is scheduled to start.

cancelNow

If true, a canceling of the event should start immediately.

coolingOffset

Requested offset to apply to the normal cooling setpoint at the time of the start of the event. It represents a temperature change that will be applied to the associated cooling set point. The temperature offsets will be calculated per the local temperature in the thermostat. The calculated temperature will be interpreted as the number of degrees to be added to the cooling set point. Sequential demand response events are not cumulative. The offset shall be applied to the normal setpoint.

coolingSetpoint

Requested cooling set point. Temperature set point is typically defined and calculated based on local temperature.

criticalityLevel

Level of criticality for the action of this control. The action taken by load control devices for an event can be solely based on this value, or in combination with other load control event fields supported by the device.

dutyCycle

Maximum "on" state duty cycle as a percentage of time. For example, if the value is 80, the device would be in an "on" state for 80% of the time for the duration of the action.

enrollmentGroup

Provides a mechanism to direct load control actions to groups of PAN devices. It can be used in conjunction with the PAN device types.

heatingOffset

Requested offset to apply to the normal heating setpoint at the time of the start of the event. It represents a temperature change that will be applied to the associated heating set point. The temperature offsets will be calculated per the local temperature in the thermostat. The calculated temperature will be interpreted as the number of degrees to be subtracted from the heating set point. Sequential demand response events are not cumulative. The offset shall be applied to the normal setpoint.

heatingSetpoint

Requested heating set point. Temperature set point is typically defined and calculated based on local temperature.

Linear Supertypes
Element, Product, Equals, Cloneable, Cloneable, Row, Serializable, Serializable, AnyRef, Any
Ordering
  1. Grouped
  2. Alphabetic
  3. By Inheritance
Inherited
  1. PanDemandResponse
  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 PanDemandResponse(EndDeviceAction: EndDeviceAction = null, appliance: String = null, avgLoadAdjustment: Double = 0.0, cancelControlMode: String = null, cancelDateTime: String = null, cancelNow: Boolean = false, coolingOffset: Double = 0.0, coolingSetpoint: Double = 0.0, criticalityLevel: String = null, dutyCycle: Double = 0.0, enrollmentGroup: String = null, heatingOffset: Double = 0.0, heatingSetpoint: Double = 0.0)

    EndDeviceAction

    EndDeviceAction Reference to the superclass object.

    appliance

    ControlledAppliance Appliance being controlled.

    avgLoadAdjustment

    Used to define a maximum energy usage limit as a percentage of the client implementations specific average energy usage. The load adjustment percentage is added to 100% creating a percentage limit applied to the client implementations specific average energy usage. A -10% load adjustment percentage will establish an energy usage limit equal to 90% of the client implementations specific average energy usage. Each load adjustment percentage is referenced to the client implementations specific average energy usage. There are no cumulative effects. The range of this field is -100% to +100% with a resolution of 1. A -100% value equals a total load shed. A +100% value will limit the energy usage to the client implementations specific average energy usage.

    cancelControlMode

    Encoding of cancel control.

    cancelDateTime

    Timestamp when a canceling of the event is scheduled to start.

    cancelNow

    If true, a canceling of the event should start immediately.

    coolingOffset

    Requested offset to apply to the normal cooling setpoint at the time of the start of the event. It represents a temperature change that will be applied to the associated cooling set point. The temperature offsets will be calculated per the local temperature in the thermostat. The calculated temperature will be interpreted as the number of degrees to be added to the cooling set point. Sequential demand response events are not cumulative. The offset shall be applied to the normal setpoint.

    coolingSetpoint

    Requested cooling set point. Temperature set point is typically defined and calculated based on local temperature.

    criticalityLevel

    Level of criticality for the action of this control. The action taken by load control devices for an event can be solely based on this value, or in combination with other load control event fields supported by the device.

    dutyCycle

    Maximum "on" state duty cycle as a percentage of time. For example, if the value is 80, the device would be in an "on" state for 80% of the time for the duration of the action.

    enrollmentGroup

    Provides a mechanism to direct load control actions to groups of PAN devices. It can be used in conjunction with the PAN device types.

    heatingOffset

    Requested offset to apply to the normal heating setpoint at the time of the start of the event. It represents a temperature change that will be applied to the associated heating set point. The temperature offsets will be calculated per the local temperature in the thermostat. The calculated temperature will be interpreted as the number of degrees to be subtracted from the heating set point. Sequential demand response events are not cumulative. The offset shall be applied to the normal setpoint.

    heatingSetpoint

    Requested heating set point. Temperature set point is typically defined and calculated based on local temperature.

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: EndDeviceAction
  5. 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
  6. def anyNull: Boolean
    Definition Classes
    Row
  7. val appliance: String
  8. def apply(i: Int): Any
    Definition Classes
    Row
  9. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  10. val avgLoadAdjustment: Double
  11. def baseclass: String

    This class name.

    This class name.

    returns

    the class name without the package prefixes

    Definition Classes
    Element
  12. 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
  13. val cancelControlMode: String
  14. val cancelDateTime: String
  15. val cancelNow: Boolean
  16. 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
  17. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  18. val coolingOffset: Double
  19. val coolingSetpoint: Double
  20. 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
    PanDemandResponse → Row
  21. val criticalityLevel: String
  22. val dutyCycle: Double
  23. 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"/>

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

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

    Return the superclass object.

    Return the superclass object.

    returns

    The typed superclass nested object.

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