Struct ChannelValidationSuccessCondition 

pub struct ChannelValidationSuccessCondition {
    pub channel: Option<ChannelLocator>,
    pub comparator: i32,
    pub threshold: f64,
    pub timeout_millis: i32,
    pub point_persistence: Option<u32>,
    pub time_persistence: Option<u32>,
}

Defines a success condition that compares channel data against a threshold value. The step succeeds when the comparison (channel_value COMPARATOR threshold) evaluates to true within the timeout period. For example, checking if a channel value is greater than 100.

NOTE: This feature is under development and not yet supported in execution. Attempting to execute a procedure with this condition will result in SafeIllegalStateException. See ProcedureTemporalActivitiesImpl.evaluateRecursively() for implementation status.

Fields

channel: Option<ChannelLocator>

The channel to validate against the threshold.

comparator: i32

The comparison operator to use. COMPARATOR_UNSPECIFIED should never be used and will be rejected at runtime.

threshold: f64

The threshold value to compare the channel data against. The comparison is: channel_value COMPARATOR threshold Using double for better precision. Note: When using COMPARATOR_EQUAL or COMPARATOR_NOT_EQUAL with floating-point channel data, be aware of potential precision issues inherent to IEEE 754.

timeout_millis: i32

Maximum time in milliseconds to wait for the condition to be satisfied. If the timeout expires before the comparison evaluates to true, the step moves to ERRORED. Must be greater than zero and at most one hour (3,600,000 milliseconds).

point_persistence: Option<u32>

optionally specify a persistence of individual points

time_persistence: Option<u32>

optionally specify a persistence duration in milliseconds (max 5 minutes) for which the condition must hold true

Implementations

impl ChannelValidationSuccessCondition

pub fn comparator(&self) -> Comparator

Returns the enum value of comparator, or the default if the field is set to an invalid enum value.

pub fn set_comparator(&mut self, value: Comparator)

Sets comparator to the provided enum value.

pub fn point_persistence(&self) -> u32

Returns the value of point_persistence, or the default value if point_persistence is unset.

pub fn time_persistence(&self) -> u32

Returns the value of time_persistence, or the default value if time_persistence is unset.

Trait Implementations

impl Clone for ChannelValidationSuccessCondition

fn clone(&self) -> ChannelValidationSuccessCondition

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ChannelValidationSuccessCondition

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

Formats the value using the given formatter.

impl Default for ChannelValidationSuccessCondition

fn default() -> Self

Returns the “default value” for a type.

impl Message for ChannelValidationSuccessCondition

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

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

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

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

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for ChannelValidationSuccessCondition

fn eq(&self, other: &ChannelValidationSuccessCondition) -> 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 StructuralPartialEq for ChannelValidationSuccessCondition