Class ReadCondition

• Defined in File ReadCondition.hpp

Inheritance Relationships

Base Type

• public eprosima::fastdds::dds::Condition (Class Condition)

Class Documentation

class ReadCondition : public eprosima::fastdds::dds::Condition

A Condition specifically dedicated to read operations and attached to one DataReader.

ReadCondition objects allow an application to specify the data samples it is interested in (by specifying the desired sample_states, view_states, and instance_states). The condition will only be triggered when suitable information is available. They are to be used in conjunction with a WaitSet as normal conditions. More than one ReadCondition may be attached to the same DataReader.

Public Functions

ReadCondition()

~ReadCondition() override

ReadCondition(const ReadCondition&) = delete

ReadCondition &operator=(const ReadCondition&) = delete

ReadCondition(ReadCondition&&) = delete

ReadCondition &operator=(ReadCondition&&) = delete

virtual RTPS_DllAPI bool get_trigger_value () const noexcept override

Retrieves the trigger_value of the Condition.

Returns

true if trigger_value is set to ‘true’, ‘false’ otherwise

RTPS_DllAPI DataReader * get_datareader () const noexcept

Retrieves the DataReader associated with the ReadCondition.

Note that there is exactly one DataReader associated with each ReadCondition.

Returns

pointer to the DataReader associated with this ReadCondition.

RTPS_DllAPI SampleStateMask get_sample_state_mask () const noexcept

Retrieves the set of sample_states taken into account to determine the trigger_value of this condition.

Returns

the sample_states specified when the ReadCondition was created.

RTPS_DllAPI ViewStateMask get_view_state_mask () const noexcept

Retrieves the set of view_states taken into account to determine the trigger_value of this condition.

Returns

the view_states specified when the ReadCondition was created.

RTPS_DllAPI InstanceStateMask get_instance_state_mask () const noexcept

Retrieves the set of instance_states taken into account to determine the trigger_value of this condition.

Returns

the instance_states specified when the ReadCondition was created.

inline detail::ReadConditionImpl *get_impl() const noexcept

Protected Attributes

std::shared_ptr<detail::ReadConditionImpl> impl_

Class implementation.

Friends

friend class detail::ReadConditionImpl