Struct ReportDescriptor 

pub struct ReportDescriptor {
    pub payload_type: ReportType,
    pub reading_type: Option<ReadingType>,
    pub units: Option<Unit>,
    pub targets: Option<Vec<Target>>,
    pub aggregate: bool,
    pub start_interval: i32,
    pub num_intervals: i32,
    pub historical: bool,
    pub frequency: i32,
    pub repeat: i32,
    pub report_intervals: ReportIntervals,
}

An object that may be used to request a report from a VEN.

Fields

payload_type: ReportType

Represents the nature of values.

See enumerations in Definitions for defined string values, or use privately defined strings

reading_type: Option<ReadingType>

Enumerated or private string signifying the type of reading.

units: Option<Unit>

Units of measure.

targets: Option<Vec<Target>>

A list of targets.

aggregate: bool

True if report should aggregate results from all targeted resources. False if report includes results for each resource.

start_interval: i32

The interval on which to generate a report. -1 indicates generate report at end of last interval.

num_intervals: i32

The number of intervals to include in a report. -1 indicates that all intervals are to be included.

historical: bool

True indicates report on intervals preceding startInterval. False indicates report on intervals following startInterval (e.g. forecast).

frequency: i32

Number of intervals that elapse between reports. -1 indicates same as numIntervals.

repeat: i32

Number of times to repeat report. 1 indicates generate one report. -1 indicates repeat indefinitely.

report_intervals: ReportIntervals

Indicates VEN report interval options. See User Guide.

Implementations

impl ReportDescriptor

pub fn new(payload_type: ReportType) -> Self

An object that may be used to request a report from a VEN. See OpenADR REST User Guide for detailed description of how configure a report request.

Trait Implementations

impl Clone for ReportDescriptor

fn clone(&self) -> ReportDescriptor

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ReportDescriptor

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ReportDescriptor

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ReportDescriptor

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for ReportDescriptor

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ReportDescriptor