Class astutedds::dcps::DataReader::Selector

ClassList > astutedds > dcps > DataReader > Selector

• #include <dcps.hpp>

Public Functions

Type	Name
	Selector (DataReader * reader) noexcept
Selector &	instance (InstanceHandle_t h) noexcept
Selector &	instance_states (InstanceStateMask m) noexcept
Selector &	max_samples (size_t n) noexcept Cap the number of samples returned by the terminal read/take.
Selector &	next_instance (InstanceHandle_t previous_handle) noexcept
std::vector< ReceivedSample >	read ()
Selector &	sample_states (SampleStateMask m) noexcept Individual mask setters.
Selector &	state (SampleStateMask sample_states, ViewStateMask view_states, InstanceStateMask instance_states) noexcept Set all three state masks in one call.
std::vector< ReceivedSample >	take ()
Selector &	view_states (ViewStateMask m) noexcept

Public Functions Documentation

function Selector

inline explicit astutedds::dcps::DataReader::Selector::Selector (
    DataReader * reader
) noexcept

---

function instance

inline Selector & astutedds::dcps::DataReader::Selector::instance (
    InstanceHandle_t h
) noexcept

Target a specific instance for the terminal read/take (§2.2.2.5.3.10 / .11). Mutually exclusive with next_instance().

---

function instance_states

inline Selector & astutedds::dcps::DataReader::Selector::instance_states (
    InstanceStateMask m
) noexcept

---

function max_samples

Cap the number of samples returned by the terminal read/take.

inline Selector & astutedds::dcps::DataReader::Selector::max_samples (
    size_t n
) noexcept

---

function next_instance

inline Selector & astutedds::dcps::DataReader::Selector::next_instance (
    InstanceHandle_t previous_handle
) noexcept

Target the instance whose handle sorts immediately after previous_handle (§2.2.2.5.3.12 / .13). Mutually exclusive with instance().

---

function read

inline std::vector< ReceivedSample > astutedds::dcps::DataReader::Selector::read () 

Terminal — read (keeps samples in cache) with the composed selector.

---

function sample_states

Individual mask setters.

inline Selector & astutedds::dcps::DataReader::Selector::sample_states (
    SampleStateMask m
) noexcept

---

function state

Set all three state masks in one call.

inline Selector & astutedds::dcps::DataReader::Selector::state (
    SampleStateMask sample_states,
    ViewStateMask view_states,
    InstanceStateMask instance_states
) noexcept

---

function take

inline std::vector< ReceivedSample > astutedds::dcps::DataReader::Selector::take () 

Terminal — take (removes samples from cache) with the composed selector.

---

function view_states

inline Selector & astutedds::dcps::DataReader::Selector::view_states (
    ViewStateMask m
) noexcept

---

---

The documentation for this class was generated from the following file include/astutedds/dcps/dcps.hpp