Struct opcua_server::prelude::DataChangeFilter

pub struct DataChangeFilter {
    pub trigger: DataChangeTrigger,
    pub deadband_type: u32,
    pub deadband_value: f64,
}

Fields

trigger: DataChangeTrigger

deadband_type: u32

deadband_value: f64

Implementations

impl DataChangeFilter

pub fn compare(
    &self,
    v1: &DataValue,
    v2: &DataValue,
    eu_range: Option<(f64, f64)>
) -> bool

Compares one data value to another and returns true if they differ, according to their trigger type of status, status/value or status/value/timestamp

pub fn compare_value_option(
    &self,
    v1: &Option<Variant>,
    v2: &Option<Variant>,
    eu_range: Option<(f64, f64)>
) -> bool

Compares two variant values to each other. Returns true if they are considered the "same".

pub fn compare_value(
    &self,
    v1: &Variant,
    v2: &Variant,
    eu_range: Option<(f64, f64)>
) -> Result<bool, StatusCode>

Compares two values, either a straight value compare or a numeric comparison against the deadband settings. If deadband is asked for and the values are not convertible into a numeric value, the result is false. The value is true if the values are the same within the limits set.

The eu_range is the engineering unit range and represents the range that the value should typically operate between. It's used for percentage change operations and ignored otherwise.

Errors

BadDeadbandFilterInvalid indicates the deadband settings were invalid, e.g. an invalid type, or the args were invalid. A (low, high) range must be supplied for a percentage deadband compare.

pub fn abs_compare(v1: f64, v2: f64, threshold_diff: f64) -> bool

Compares the difference between v1 and v2 to the threshold. The two values are considered equal if their difference is less than or equal to the threshold.

pub fn pct_compare(
    v1: f64,
    v2: f64,
    low: f64,
    high: f64,
    threshold_pct_change: f64
) -> bool

Compares the percentage difference between v1 and v2 using the low-high range as the comparison. The two values are considered equal if their perentage difference is less than or equal to the threshold.

Trait Implementations

impl BinaryEncoder<DataChangeFilter> for DataChangeFilter

fn byte_len(&self) -> usize

Returns the exact byte length of the structure as it would be if encode were called. This may be called prior to writing to ensure the correct amount of space is available.

fn encode<S>(&self, stream: &mut S) -> Result<usize, StatusCode> where
    S: Write, 

Encodes the instance to the write stream.

fn decode<S>(
    stream: &mut S,
    decoding_limits: &DecodingLimits
) -> Result<DataChangeFilter, StatusCode> where
    S: Read, 

Decodes an instance from the read stream. The decoding limits are restrictions set by the server / client on the length of strings, arrays etc. If these limits are exceeded the implementation should return with a BadDecodingError as soon as possible.

fn encode_to_vec(&self) -> Vec<u8>

impl Clone for DataChangeFilter

fn clone(&self) -> DataChangeFilter

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DataChangeFilter

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

Formats the value using the given formatter.

impl PartialEq<DataChangeFilter> for DataChangeFilter

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

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

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

This method tests for !=.

impl Serialize for DataChangeFilter

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

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for DataChangeFilter