DDS::Selector< T > Class Template Reference

Configures a selection to access data-samples from a DataReader. More...

#include <managed_subscription.h>

Public Member Functions
Selector ^	instance (DDS::InstanceHandle_t% instance_handle)
	Select data for a specific instance. More...
Selector ^	next_instance (DDS::InstanceHandle_t% instance_handle)
	Select data for a specific instance after the specified instance. More...
Selector ^	sample_state (DDS::SampleStateKind state)
	Selects data with a sample state. More...
Selector ^	view_state (DDS::ViewStateKind state)
	Selects data with a view state. More...
Selector ^	instance_state (DDS::InstanceStateKind state)
	Selects data with an instance state. More...
Selector ^	condition (DDS::ReadCondition^ condition)
	Selects data that matches a ReadCondition or QueryCondition. More...
Selector ^	max_samples (System::Int32 max_samples)
	Specifies the maximum number of samples to access. More...
DDS::Ext::LoanedSamples< T > ^	read ()
	Reads the samples using the parameters configured in this Selector. More...
DDS::Ext::LoanedSamples< T > ^	take ()
	Takes the samples using the parameters configured in this Selector. More...

Detailed Description

template<typename T>
class DDS::Selector< T >

Configures a selection to access data-samples from a DataReader.

A selector is obtained with TypedDataReader::select().

Member Function Documentation

instance()

template<typename T>

Selector ^ DDS::Selector< T >::instance ( DDS::InstanceHandle_t%  instance_handle )

inline

Select data for a specific instance.

If not specified, all instances are selected.

Note

next_instance() and instance() cannot be specified at the same time.

next_instance()

template<typename T>

Selector ^ DDS::Selector< T >::next_instance ( DDS::InstanceHandle_t%  instance_handle )

inline

Select data for a specific instance after the specified instance.

Note

next_instance() and instance() cannot be specified at the same time.

See also

DDS::TypedDataReader::read_next_instance

sample_state()

template<typename T>

Selector ^ DDS::Selector< T >::sample_state ( DDS::SampleStateKind  state )

inline

Selects data with a sample state.

Note

If condition() is also specified, sample_state is ignored

[default] SampleStateKind::ANY_SAMPLE_STATE

view_state()

template<typename T>

Selector ^ DDS::Selector< T >::view_state ( DDS::ViewStateKind  state )

inline

Selects data with a view state.

Note

If condition() is also specified, view_state is ignored

[default] ViewStateKind::ANY_VIEW_STATE

instance_state()

template<typename T>

Selector ^ DDS::Selector< T >::instance_state ( DDS::InstanceStateKind  state )

inline

Selects data with an instance state.

Note

If condition() is also specified, instance_state is ignored

[default] InstanceStateKind::ANY_INSTANCE_STATE

condition()

template<typename T>

Selector ^ DDS::Selector< T >::condition ( DDS::ReadCondition^  condition )

inline

Selects data that matches a ReadCondition or QueryCondition.

Note

If condition() is specified, sample_state(), view_state() and instance_state() are ignored.

[default] No condition

See also

DDS::TypedDataReader::read_w_condition

max_samples()

template<typename T>

Selector ^ DDS::Selector< T >::max_samples ( System::Int32  max_samples )

inline

Specifies the maximum number of samples to access.

[default] DDS::ResourceLimitsQosPolicy::LENGTH_UNLIMITED (see DDS::TypedDataReader::take)

read()

template<typename T>

DDS::Ext::LoanedSamples<T> ^ DDS::Selector< T >::read ( )

inline

Reads the samples using the parameters configured in this Selector.

take()

template<typename T>

DDS::Ext::LoanedSamples<T> ^ DDS::Selector< T >::take ( )

inline

Takes the samples using the parameters configured in this Selector.