Struct sep2_common::packages::drlc::EndDeviceControl

pub struct EndDeviceControl {

    pub appliance_load_reduction: Option<ApplianceLoadReduction>,
    pub device_category: DeviceCategoryType,
    pub dr_program_mandatory: bool,
    pub duty_cycle: Option<DutyCycle>,
    pub load_shift_forward: bool,
    pub offset: Option<Offset>,
    pub override_duration: Option<Uint16>,
    pub set_point: Option<SetPoint>,
    pub target_reduction: Option<TargetReduction>,
    pub randomize_duration: Option<OneHourRangeType>,
    pub randomize_start: Option<OneHourRangeType>,
    pub creation_time: TimeType,
    pub event_status: EventStatus,
    pub interval: DateTimeInterval,
    pub mrid: MRIDType,
    pub description: Option<String32>,
    pub version: Option<VersionType>,
    pub subscribable: Option<SubscribableType>,
    pub reply_to: Option<String>,
    pub response_required: Option<ResponseRequired>,
    pub href: Option<String>,
}

Available on crate feature drlc only.

Instructs an EndDevice to perform a specified action.

Fields

appliance_load_reduction: Option<ApplianceLoadReduction>

device_category: DeviceCategoryType

Specifies the bitmap indicating the categories of devices that SHOULD respond. Devices SHOULD ignore events that do not indicate their device category.

dr_program_mandatory: bool

A flag to indicate if the EndDeviceControl is considered a mandatory event as defined by the service provider issuing the EndDeviceControl. The drProgramMandatory flag alerts the client/user that they will be subject to penalty or ineligibility based on the service provider’s program rules for that deviceCategory.

duty_cycle: Option<DutyCycle>

load_shift_forward: bool

Indicates that the event intends to increase consumption. A value of true indicates the intention to increase usage value, and a value of false indicates the intention to decrease usage.

offset: Option<Offset>

override_duration: Option<Uint16>

The overrideDuration attribute provides a duration, in seconds, for which a client device is allowed to override this EndDeviceControl and still meet the contractual agreement with a service provider without opting out. If overrideDuration is not specified, then it SHALL default to 0.

set_point: Option<SetPoint>

target_reduction: Option<TargetReduction>

randomize_duration: Option<OneHourRangeType>

Number of seconds boundary inside which a random value must be selected to be applied to the associated interval duration, to avoid sudden synchronized demand changes. If related to price level changes, sign may be ignored. Valid range is -3600 to 3600. If not specified, 0 is the default.

randomize_start: Option<OneHourRangeType>

Number of seconds boundary inside which a random value must be selected to be applied to the associated interval start time, to avoid sudden synchronized demand changes. If related to price level changes, sign may be ignored. Valid range is -3600 to 3600. If not specified, 0 is the default.

creation_time: TimeType

The time at which the Event was created.

event_status: EventStatus

interval: DateTimeInterval

The period during which the Event applies.

mrid: MRIDType

The global identifier of the object.

description: Option<String32>

The description is a human readable text describing or naming the object.

version: Option<VersionType>

Contains the version number of the object. See the type definition for details.

subscribable: Option<SubscribableType>

Indicates whether or not subscriptions are supported for this resource, and whether or not conditional (thresholds) are supported. If not specified, is “not subscribable” (0).

reply_to: Option<String>

A reference to the response resource address (URI). Required on a response to a GET if responseRequired is “true”.

response_required: Option<ResponseRequired>

Indicates whether or not a response is required upon receipt, creation or update of this resource. Responses shall be posted to the collection specified in “replyTo”. If the resource has a deviceCategory field, devices that match one or more of the device types indicated in deviceCategory SHALL respond according to the rules listed below. If the category does not match, the device SHALL NOT respond. If the resource does not have a deviceCategory field, a device receiving the resource SHALL respond according to the rules listed below. Value encoded as hex according to the following bit assignments, any combination is possible. See Table 27 for the list of appropriate Response status codes to be sent for these purposes. 0 - End device shall indicate that message was received 1 - End device shall indicate specific response. 2 - End user / customer response is required. All other values reserved.

href: Option<String>

A reference to the resource address (URI). Required in a response to a GET, ignored otherwise.

Trait Implementations

impl Clone for EndDeviceControl

fn clone(&self) -> EndDeviceControl

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for EndDeviceControl

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for EndDeviceControl

fn default() -> EndDeviceControl

Returns the “default value” for a type.

impl Ord for EndDeviceControl

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<EndDeviceControl> for EndDeviceControl

fn eq(&self, other: &EndDeviceControl) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd<EndDeviceControl> for EndDeviceControl

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl SEEvent for EndDeviceControl

fn creation_time(&self) -> TimeType

fn event_status(&self) -> &EventStatus

fn interval(&self) -> &DateTimeInterval

impl SEIdentifiedObject for EndDeviceControl

fn mrid(&self) -> &MRIDType

fn description(&self) -> Option<&String32>

fn version(&self) -> Option<VersionType>

impl SERandomizableEvent for EndDeviceControl

fn randomize_duration(&self) -> Option<OneHourRangeType>

fn randomize_start(&self) -> Option<OneHourRangeType>

impl SEResource for EndDeviceControl

fn href(&self) -> Option<&str>

impl SERespondableResource for EndDeviceControl

fn reply_to(&self) -> Option<&str>

fn response_required(&self) -> Option<ResponseRequired>

impl SESubscribableResource for EndDeviceControl

fn subscribable(&self) -> Option<SubscribableType>

impl Validate for EndDeviceControl

fn validate(&self) -> Result<(), String>

impl YaDeserialize for EndDeviceControl

fn deserialize<R: Read>(reader: &mut Deserializer<R>) -> Result<Self, String>where Self: Sized,

impl YaSerialize for EndDeviceControl

fn name() -> &'static strwhere Self: Sized,

fn serialize<W: Write>(&self, writer: &mut Serializer<W>) -> Result<(), String>where Self: Sized,

fn serialize_attributes( &self, source_attributes: Vec<OwnedAttribute>, source_namespace: Namespace ) -> Result<(Vec<OwnedAttribute>, Namespace), String>where Self: Sized,

impl Eq for EndDeviceControl

impl SERespondableSubscribableIdentifiedObject for EndDeviceControl

impl StructuralEq for EndDeviceControl

impl StructuralPartialEq for EndDeviceControl