Struct dust_dds::infrastructure::condition::StatusCondition

pub struct StatusCondition(_);

A StatusCondition object is a specific Condition that is associated with each Entity. The trigger_value of the StatusCondition depends on the communication status of that entity (e.g., arrival of data, loss of information, etc.), ‘filtered’ by the set of enabled_statuses on the StatusCondition.

Implementations

impl StatusCondition

pub fn get_enabled_statuses(&self) -> Vec<StatusKind>

This operation retrieves the list of communication statuses that are taken into account to determine the trigger_value of the StatusCondition. This operation returns the statuses that were explicitly set on the last call to StatusCondition::set_enabled_statuses or, if it was never called, the default list of enabled statuses which includes all the statuses.

pub fn set_enabled_statuses(&self, mask: &[StatusKind]) -> DdsResult<()>

This operation defines the list of communication statuses that are taken into account to determine the trigger_value of the StatusCondition. This operation may change the trigger_value of the StatusCondition. WaitSet objects behavior depend on the changes of the trigger_value of their attached conditions. Therefore, any WaitSet to which the StatusCondition is attached is potentially affected by this operation. If this function is not invoked, the default list of enabled statuses includes all the statuses.

pub fn get_entity(&self)

This operation returns the Entity associated with the StatusCondition. Note that there is exactly one Entity associated with each StatusCondition.

impl StatusCondition

This implementation block contains the Condition operations for the StatusCondition.

pub fn get_trigger_value(&self) -> bool

This operation retrieves the trigger_value of the StatusCondition.

Trait Implementations

impl Clone for StatusCondition

fn clone(&self) -> StatusCondition

Returns a copy of the value.

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

Performs copy-assignment from source.