DataReader that provides static memory to TypedDataReader. More...

#include <StaticDataReader.hpp>

Public Member Functions
	StaticDataReader (BaseSubscriber &subscriber, BaseTopic &topic, const DataReaderQos &qos, DataReaderListener *listener, const StatusMask &mask) noexcept
	StaticDataReader constructor. More...

virtual	~StaticDataReader () noexcept=default
	Virtual destructor. More...

	StaticDataReader (const StaticDataReader &) noexcept=delete
	Copy deleted. More...

	StaticDataReader (StaticDataReader &&) noexcept=delete
	Movement deleted. More...

StaticDataReader &	operator= (const StaticDataReader &) noexcept=delete
	Copy operator deleted. More...

StaticDataReader &	operator= (StaticDataReader &&) noexcept=delete
	Movement operator deleted due private references. More...

ReturnCode	enable () noexcept override

Public Member Functions inherited from eprosima::safedds::dds::TypedDataReader< TS >
ReturnCode	take_next_sample (Data &data, dds::SampleInfo &info) noexcept
	This operation copies the next, non-previously accessed Data value from the DataReader and removes it from the DataReader instance handler so it is no longer accessible. The operation also copies the corresponding SampleInfo. More...

ReturnCode	get_key_value (Data &key_holder, const InstanceHandle &handle) noexcept
	Get key value of an instance. More...

InstanceHandle	lookup_instance (const Data &instance) const noexcept
	Lookup instance. More...

ReturnCode	read (memory::IList< Data > &data_values, memory::IList< SampleInfo > &sample_infos, int32_t max_samples, SampleStateMask &sample_states, ViewStateMask &view_states, InstanceStateMask &instance_states) noexcept
	Access a collection of Data values from the DataReader. More...

ReturnCode	take (memory::IList< Data > &data_values, memory::IList< SampleInfo > &sample_infos, int32_t max_samples, SampleStateMask &sample_states, ViewStateMask &view_states, InstanceStateMask &instance_states) noexcept
	Access a collection of Data values from the DataReader. More...

ReturnCode	read_w_condition (memory::IList< Data > &data_values, memory::IList< SampleInfo > &sample_infos, int32_t max_samples, ReadCondition &condition) noexcept
	This operation accesses via ‘read’ the samples that match the criteria specified in the ReadCondition. More...

ReturnCode	take_w_condition (memory::IList< Data > &data_values, memory::IList< SampleInfo > &sample_infos, int32_t max_samples, ReadCondition &condition) noexcept
	This operation accesses via ‘take’ the samples that match the criteria specified in the ReadCondition. More...

ReturnCode	read_next_sample (Data &data, dds::SampleInfo &info) noexcept
	This operation copies the next, non-previously accessed Data value from the DataReader; the operation also copies the corresponding SampleInfo. The implied order among the samples stored in the DataReader is the same as for the read operation. More...

ReturnCode	read_instance (memory::IList< Data > &data_values, memory::IList< SampleInfo > &sample_infos, int32_t max_samples, const InstanceHandle &handle, SampleStateMask &sample_states, ViewStateMask &view_states, InstanceStateMask &instance_states) noexcept
	Access a collection of data samples from the DataReader. More...

ReturnCode	take_instance (memory::IList< Data > &data_values, memory::IList< SampleInfo > &sample_infos, int32_t max_samples, const InstanceHandle &handle, SampleStateMask &sample_states, ViewStateMask &view_states, InstanceStateMask &instance_states) noexcept
	Access a collection of data samples from the DataReader. More...

ReturnCode	read_next_instance (memory::IList< Data > &data_values, memory::IList< SampleInfo > &sample_infos, int32_t max_samples, const InstanceHandle &previous_handle, SampleStateMask &sample_states, ViewStateMask &view_states, InstanceStateMask &instance_states) noexcept
	Access a collection of data samples from the DataReader. More...

ReturnCode	take_next_instance (memory::IList< Data > &data_values, memory::IList< SampleInfo > &sample_infos, int32_t max_samples, const InstanceHandle &previous_handle, SampleStateMask &sample_states, ViewStateMask &view_states, InstanceStateMask &instance_states) noexcept
	Access a collection of data samples from the DataReader. More...

ReturnCode	read_next_instance_w_condition (memory::IList< Data > &data_values, memory::IList< SampleInfo > &sample_infos, int32_t max_samples, const InstanceHandle &previous_handle, ReadCondition &condition) noexcept
	Access a collection of data samples from the DataReader. More...

ReturnCode	take_next_instance_w_condition (memory::IList< Data > &data_values, memory::IList< SampleInfo > &sample_infos, int32_t max_samples, const InstanceHandle &previous_handle, ReadCondition &condition) noexcept
	Access a collection of data samples from the DataReader. More...

ReturnCode	return_loan (memory::IList< Data > &data_values, memory::IList< SampleInfo > &sample_infos) noexcept
	Return loan. More...

Additional Inherited Members
Public Types inherited from eprosima::safedds::dds::TypedDataReader< TS >
using	Data = typename TS::DataType
	Alias for nested DataType. More...

Static Public Member Functions inherited from eprosima::safedds::dds::TypedDataReader< TS >
static TypedDataReader< TS > *	downcast (DataReader &reader) noexcept
	Downcast TypedDataReader from DataReader. More...

Protected Member Functions inherited from eprosima::safedds::dds::TypedDataReader< TS >
	TypedDataReader (BaseSubscriber &subscriber, BaseTopic &topic, const DataReaderQos &qos, DataReaderListener *listener, StatusMask mask, IDataReaderInstanceStorage &instance_storage, IDataReaderWriterStorage &writer_storage, memory::ISet< protocol::GUID > &local_ignored_writers, protocol::rtps::Reader &reader) noexcept
	TypedDataReader constructor. More...

	~TypedDataReader () noexcept=default
	Protected destructor ownership defined on creation. More...

	TypedDataReader (const TypedDataReader &) noexcept=delete
	Copy deleted. More...

	TypedDataReader (TypedDataReader &&) noexcept=delete
	Movement deleted. More...

TypedDataReader &	operator= (const TypedDataReader &) noexcept=delete
	Copy operator deleted. More...

TypedDataReader &	operator= (TypedDataReader &&) noexcept=delete
	Movement operator deleted. More...

Detailed Description

template<class TS, uint32_t MaxRemoteWriters, uint32_t MaxLocalWriters, uint32_t MaxInstances, uint32_t MaxSamplesPerInstance>
class eprosima::safedds::dds::StaticDataReader< TS, MaxRemoteWriters, MaxLocalWriters, MaxInstances, MaxSamplesPerInstance >

DataReader that provides static memory to TypedDataReader.

Constructor & Destructor Documentation

◆ StaticDataReader() [1/3]

template<class TS , uint32_t MaxRemoteWriters, uint32_t MaxLocalWriters, uint32_t MaxInstances, uint32_t MaxSamplesPerInstance>

eprosima::safedds::dds::StaticDataReader< TS, MaxRemoteWriters, MaxLocalWriters, MaxInstances, MaxSamplesPerInstance >::StaticDataReader	(	BaseSubscriber &	subscriber,
		BaseTopic &	topic,
		const DataReaderQos &	qos,
		DataReaderListener *	listener,
		const StatusMask &	mask
	)

inlinenoexcept

StaticDataReader constructor.

Parameters

subscriber	reference to BaseSubscriber. Ownership is not taken.
topic	reference to BaseTopic. Ownership is not taken.
qos	data reader qos.
listener	data reader listener. Ownership is not taken.
mask	status mask.

◆ ~StaticDataReader()

template<class TS , uint32_t MaxRemoteWriters, uint32_t MaxLocalWriters, uint32_t MaxInstances, uint32_t MaxSamplesPerInstance>

virtual eprosima::safedds::dds::StaticDataReader< TS, MaxRemoteWriters, MaxLocalWriters, MaxInstances, MaxSamplesPerInstance >::~StaticDataReader ( )

virtualdefaultnoexcept

Virtual destructor.

◆ StaticDataReader() [2/3]

template<class TS , uint32_t MaxRemoteWriters, uint32_t MaxLocalWriters, uint32_t MaxInstances, uint32_t MaxSamplesPerInstance>

eprosima::safedds::dds::StaticDataReader< TS, MaxRemoteWriters, MaxLocalWriters, MaxInstances, MaxSamplesPerInstance >::StaticDataReader ( const StaticDataReader< TS, MaxRemoteWriters, MaxLocalWriters, MaxInstances, MaxSamplesPerInstance > & )

deletenoexcept

Copy deleted.

◆ StaticDataReader() [3/3]

template<class TS , uint32_t MaxRemoteWriters, uint32_t MaxLocalWriters, uint32_t MaxInstances, uint32_t MaxSamplesPerInstance>

eprosima::safedds::dds::StaticDataReader< TS, MaxRemoteWriters, MaxLocalWriters, MaxInstances, MaxSamplesPerInstance >::StaticDataReader ( StaticDataReader< TS, MaxRemoteWriters, MaxLocalWriters, MaxInstances, MaxSamplesPerInstance > && )

deletenoexcept

Movement deleted.

Member Function Documentation

◆ enable()

template<class TS , uint32_t MaxRemoteWriters, uint32_t MaxLocalWriters, uint32_t MaxInstances, uint32_t MaxSamplesPerInstance>

ReturnCode eprosima::safedds::dds::StaticDataReader< TS, MaxRemoteWriters, MaxLocalWriters, MaxInstances, MaxSamplesPerInstance >::enable ( )

inlineoverridenoexcept

◆ operator=() [1/2]

template<class TS , uint32_t MaxRemoteWriters, uint32_t MaxLocalWriters, uint32_t MaxInstances, uint32_t MaxSamplesPerInstance>

StaticDataReader& eprosima::safedds::dds::StaticDataReader< TS, MaxRemoteWriters, MaxLocalWriters, MaxInstances, MaxSamplesPerInstance >::operator= ( const StaticDataReader< TS, MaxRemoteWriters, MaxLocalWriters, MaxInstances, MaxSamplesPerInstance > & )

deletenoexcept

Copy operator deleted.

◆ operator=() [2/2]

template<class TS , uint32_t MaxRemoteWriters, uint32_t MaxLocalWriters, uint32_t MaxInstances, uint32_t MaxSamplesPerInstance>

StaticDataReader& eprosima::safedds::dds::StaticDataReader< TS, MaxRemoteWriters, MaxLocalWriters, MaxInstances, MaxSamplesPerInstance >::operator= ( StaticDataReader< TS, MaxRemoteWriters, MaxLocalWriters, MaxInstances, MaxSamplesPerInstance > && )

deletenoexcept

Movement operator deleted due private references.

The documentation for this class was generated from the following file:

build/docs/user_manual/main/tmp/include/safedds/dds/static/StaticDataReader.hpp

Public Member Functions

Additional Inherited Members

Detailed Description

template<class TS, uint32_t MaxRemoteWriters, uint32_t MaxLocalWriters, uint32_t MaxInstances, uint32_t MaxSamplesPerInstance> class eprosima::safedds::dds::StaticDataReader< TS, MaxRemoteWriters, MaxLocalWriters, MaxInstances, MaxSamplesPerInstance >

Constructor & Destructor Documentation

◆ StaticDataReader() [1/3]

◆ ~StaticDataReader()

◆ StaticDataReader() [2/3]

◆ StaticDataReader() [3/3]

Member Function Documentation

◆ enable()

◆ operator=() [1/2]

◆ operator=() [2/2]

template<class TS, uint32_t MaxRemoteWriters, uint32_t MaxLocalWriters, uint32_t MaxInstances, uint32_t MaxSamplesPerInstance>
class eprosima::safedds::dds::StaticDataReader< TS, MaxRemoteWriters, MaxLocalWriters, MaxInstances, MaxSamplesPerInstance >