Skip to main content

EventData

Struct EventData 

Source
pub struct EventData {
Show 15 fields pub event_id: i32, pub timestamp: DateTime, pub trigger: EventTrigger, pub actual_value: String, pub component: Component, pub event_notification_type: EventNotification, pub variable: Variable, pub cause: Option<i32>, pub tech_code: Option<String>, pub tech_info: Option<String>, pub cleared: Option<bool>, pub transaction_id: Option<String>, pub variable_monitoring_id: Option<i32>, pub severity: Option<i32>, pub custom_data: Option<CustomData>,
}
Expand description

Class to report an event notification for a component-variable.

The OCPP 2.1 EventData data type.

Fields§

§event_id: i32

Identifies the event. This field can be referred to as a cause by other events.

§timestamp: DateTime

Timestamp of the moment the report was generated.

§trigger: EventTrigger

The trigger member.

§actual_value: String

Actual value (attributeType Actual) of the variable.

The Configuration Variable <<configkey-reporting-value-size,ReportingValueSize>> can be used to limit GetVariableResult.attributeValue, VariableAttribute.value and EventData.actualValue. The max size of these values will always remain equal.

§component: Component

The component member.

§event_notification_type: EventNotification

The eventNotificationType member.

§variable: Variable

The variable member.

§cause: Option<i32>

Refers to the Id of an event that is considered to be the cause for this event.

§tech_code: Option<String>

Technical (error) code as reported by component.

§tech_info: Option<String>

Technical detail information as reported by component.

§cleared: Option<bool>

Cleared is set to true to report the clearing of a monitored situation, i.e. a ‘return to normal’.

§transaction_id: Option<String>

If an event notification is linked to a specific transaction, this field can be used to specify its transactionId.

§variable_monitoring_id: Option<i32>

Identifies the VariableMonitoring which triggered the event.

§severity: Option<i32>

(2.1) Severity associated with the monitor in variableMonitoringId or with the hardwired notification.

§custom_data: Option<CustomData>

The customData member.

Implementations§

Source§

impl EventData

Source

pub fn new( event_id: i32, timestamp: impl Into<DateTime>, trigger: EventTrigger, actual_value: impl Into<String>, component: Component, event_notification_type: EventNotification, variable: Variable, ) -> Self

Creates a EventData from its required fields.

Source

pub fn with_cause(self, value: i32) -> Self

Sets the optional cause field.

Source

pub fn with_tech_code(self, value: impl Into<String>) -> Self

Sets the optional techCode field.

Source

pub fn with_tech_info(self, value: impl Into<String>) -> Self

Sets the optional techInfo field.

Source

pub fn with_cleared(self, value: bool) -> Self

Sets the optional cleared field.

Source

pub fn with_transaction_id(self, value: impl Into<String>) -> Self

Sets the optional transactionId field.

Source

pub fn with_variable_monitoring_id(self, value: i32) -> Self

Sets the optional variableMonitoringId field.

Source

pub fn with_severity(self, value: i32) -> Self

Sets the optional severity field.

Source

pub fn with_custom_data(self, value: CustomData) -> Self

Sets the optional customData field.

Trait Implementations§

Source§

impl Clone for EventData

Source§

fn clone(&self) -> EventData

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for EventData

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for EventData

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for EventData

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl Serialize for EventData

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for EventData

Source§

impl Validate for EventData

Source§

fn validate_at(&self, path: &mut ValidationPath, out: &mut Violations)

Appends this value’s violations to out, relative to path.
Source§

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

Validates this value from the payload root.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.