Namespaces
namespace	cond

namespace	detail

namespace	functors

namespace	qos

namespace	status

Classes
class	AnyDataReader

class	AnyDataReaderListener

class	DataReader

class	DataReaderListener

class	LoanedSamples

class	NoOpAnyDataReaderListener

class	NoOpDataReaderListener

class	NoOpSubscriberListener

class	Query

class	Sample

class	SharedSamples

class	SubscriberListener

class	TCoherentAccess

class	TGenerationCount

class	TRank

class	TSampleInfo

class	TSubscriber

Typedefs
typedef dds::sub::detail::CoherentAccess	CoherentAccess

typedef detail::GenerationCount	GenerationCount

typedef detail::Rank	Rank

typedef detail::Sample	Sample

typedef detail::SampleInfo	SampleInfo

typedef ::dds::sub::detail::Subscriber	Subscriber

Functions
template<typename T >
T::iterator	begin (T &t)

const dds::sub::Subscriber &	builtin_subscriber (const dds::domain::DomainParticipant &dp)

template<typename T >
T::const_iterator	cbegin (const T &t)

template<typename T >
T::const_iterator	cend (const T &t)

dds::sub::functors::ContentFilterManipulatorFunctor	content (const dds::sub::Query &query)

template<typename T >
T::iterator	end (T &t)

template<typename READER , typename FwdIterator >
uint32_t	find (const dds::sub::Subscriber &sub, const std::string &topic_name, FwdIterator begin, uint32_t max_size)

template<typename READER , typename BinIterator >
uint32_t	find (const dds::sub::Subscriber &sub, const std::string &topic_name, BinIterator begin)

template<typename READER , typename T , typename FwdIterator >
uint32_t	find (const dds::sub::Subscriber &sub, const dds::topic::TopicDescription< T > &topic_description, FwdIterator begin, uint32_t max_size)

template<typename READER , typename T , typename BinIterator >
uint32_t	find (const dds::sub::Subscriber &sub, const dds::topic::TopicDescription< T > &topic_description, BinIterator begin)

template<typename READER , typename FwdIterator >
uint32_t	find (const dds::sub::Subscriber &sub, const dds::sub::status::DataState &rs, FwdIterator begin, uint32_t max_size)

template<typename READER , typename BinIterator >
uint32_t	find (const dds::sub::Subscriber &sub, const dds::sub::status::DataState &rs, BinIterator begin)

template<typename T >
DataReader< T >	get (const AnyDataReader &adr)

void	ignore (const dds::domain::DomainParticipant &dp, const dds::core::InstanceHandle &handle)

template<typename FwdIterator >
void	ignore (const dds::domain::DomainParticipant &dp, FwdIterator begin, FwdIterator end)

dds::sub::functors::InstanceManipulatorFunctor	instance (const dds::core::InstanceHandle &h)

template<typename T >
const ::dds::core::InstanceHandleSeq	matched_publications (const dds::sub::DataReader< T > &dw)

template<typename T , typename FwdIterator >
::dds::core::InstanceHandleSeq &	matched_publications (const dds::sub::DataReader< T > &dw, FwdIterator begin, FwdIterator end)

template<typename T >
const dds::topic::SubscriptionBuiltinTopicData	matched_publications_data (const dds::sub::DataReader< T > &dw, const ::dds::core::InstanceHandle &h)

dds::sub::functors::MaxSamplesManipulatorFunctor	max_samples (uint32_t n)

template<typename T , template< typename Q > class D>
LoanedSamples< T, D< T > >	move (LoanedSamples< T, D< T > > &a)

dds::sub::functors::NextInstanceManipulatorFunctor	next_instance (const dds::core::InstanceHandle &h)

template<typename SELECTOR >
SELECTOR &	read (SELECTOR &selector)

dds::sub::functors::StateFilterManipulatorFunctor	state (const dds::sub::status::DataState &s)

template<typename SELECTOR >
SELECTOR &	take (SELECTOR &selector)

Typedef Documentation

typedef dds::sub::detail::CoherentAccess dds::sub::CoherentAccess

Definition at line 25 of file CoherentAccess.hpp.

typedef detail::GenerationCount dds::sub::GenerationCount

Definition at line 7 of file GenerationCount.hpp.

typedef detail::Rank dds::sub::Rank

Definition at line 7 of file Rank.hpp.

typedef detail::Sample dds::sub::Sample

Definition at line 26 of file Sample.hpp.

typedef detail::SampleInfo dds::sub::SampleInfo

Definition at line 8 of file SampleInfo.hpp.

typedef ::dds::sub::detail::Subscriber dds::sub::Subscriber

Definition at line 26 of file Subscriber.hpp.

Function Documentation

template<typename T >

T::iterator dds::sub::begin ( T & t )

Definition at line 15 of file array.hpp.

const dds::sub::Subscriber& dds::sub::builtin_subscriber ( const dds::domain::DomainParticipant & dp )

Retrieves the built-in subscriber for the given domain participant.

Parameters

dp	the domain participant.

template<typename T >

T::const_iterator dds::sub::cbegin ( const T & t )

template<typename T >

T::const_iterator dds::sub::cend ( const T & t )

dds::sub::functors::ContentFilterManipulatorFunctor dds::sub::content ( const dds::sub::Query & query )

inline

template<typename T >

T::iterator dds::sub::end ( T & t )

Definition at line 19 of file array.hpp.

template<typename READER , typename FwdIterator >

uint32_t dds::sub::find	(	const dds::sub::Subscriber &	sub,
		const std::string &	topic_name,
		FwdIterator	begin,
		uint32_t	max_size
	)

This function retrieves a previously-created DataReader belonging to the Subscriber that is attached to a Topic with a matching topic_name. If no such DataReader exists, the operation will return an empty container. The use of this operation on the built-in Subscriber allows access to the built-in DataReader entities for the built-in topics

Returns: the total number of elements found. Notice that at most max_size will be copied using the provided iterator.

template<typename READER , typename BinIterator >

uint32_t dds::sub::find	(	const dds::sub::Subscriber &	sub,
		const std::string &	topic_name,
		BinIterator	begin
	)

This function retrieves a previously-created DataReader belonging to the Subscriber that is attached to a Topic with a matching topic_name. If no such DataReader exists, the operation will return an empty container. The use of this operation on the built-in Subscriber allows access to the built-in DataReader entities for the built-in topics

Returns: the total number of elements found and copied over.

template<typename READER , typename T , typename FwdIterator >

uint32_t dds::sub::find	(	const dds::sub::Subscriber &	sub,
		const dds::topic::TopicDescription< T > &	topic_description,
		FwdIterator	begin,
		uint32_t	max_size
	)

This function retrieves a previously-created DataReader belonging to the Subscriber that is attached to a Topic with a matching topic_name. If no such DataReader exists, the operation will return an empty container. The use of this operation on the built-in Subscriber allows access to the built-in DataReader entities for the built-in topics

template<typename READER , typename T , typename BinIterator >

uint32_t dds::sub::find	(	const dds::sub::Subscriber &	sub,
		const dds::topic::TopicDescription< T > &	topic_description,
		BinIterator	begin
	)

This function retrieves a previously-created DataReader belonging to the Subscriber that is attached to a Topic with a matching topic_name. If no such DataReader exists, the operation will return an empty container. The use of this operation on the built-in Subscriber allows access to the built-in DataReader entities for the built-in topics

template<typename READER , typename FwdIterator >

uint32_t dds::sub::find	(	const dds::sub::Subscriber &	sub,
		const dds::sub::status::DataState &	rs,
		FwdIterator	begin,
		uint32_t	max_size
	)

This function retrieves a previously-created DataReader belonging to the Subscriber that is in a specific state.

template<typename READER , typename BinIterator >

uint32_t dds::sub::find	(	const dds::sub::Subscriber &	sub,
		const dds::sub::status::DataState &	rs,
		BinIterator	begin
	)

This function retrieves a previously-created DataReader belonging to the Subscriber that is in a specific state.

template<typename T >

DataReader<T> dds::sub::get ( const AnyDataReader & adr )

Extracts a typed DataReader from an AnyDataReader.

void dds::sub::ignore	(	const dds::domain::DomainParticipant &	dp,
		const dds::core::InstanceHandle &	handle
	)

Ignore subscriptions.

Parameters

dp	the `DomainParticipant` for which the remote entity will be ignored
handle	the `InstanceHandle` of the remote entity that has to be ignored

template<typename FwdIterator >

void dds::sub::ignore	(	const dds::domain::DomainParticipant &	dp,
		FwdIterator	begin,
		FwdIterator	end
	)

Ignore subscriptions.

Parameters

dp	the `DomainParticipant` for which the remote entity will be ignored
handle	the `InstanceHandle` of the remote entity that has to be ignored

dds::sub::functors::InstanceManipulatorFunctor dds::sub::instance ( const dds::core::InstanceHandle & h )

inline

template<typename T >

const ::dds::core::InstanceHandleSeq dds::sub::matched_publications ( const dds::sub::DataReader< T > & dw )

This operation retrieves the list of publications currently “associated” with the DataReader; that is, publications that have a matching Topic and compatible QoS that the application has not indicated should be “ignored” by means of the dds::domain::ignore operation. The handles returned in the 'publication_handles' list are the ones that are used by the DDS implementation to locally identify the corresponding matched DataWriter entities. These handles match the ones that appear in the 'instance_handle' field of the SampleInfo when reading the “DCPSPublications” builtin topic. The operation may fail if the infrastructure does not locally maintain the connectivity information.

template<typename T , typename FwdIterator >

::dds::core::InstanceHandleSeq& dds::sub::matched_publications	(	const dds::sub::DataReader< T > &	dw,
		FwdIterator	begin,
		FwdIterator	end
	)

This operation retrieves the list of publications currently “associated” with the DataReader; that is, publications that have a matching Topic and compatible QoS that the application has not indicated should be “ignored” by means of the dds::domain::ignore operation. The handles returned in the 'publication_handles' list are the ones that are used by the DDS implementation to locally identify the corresponding matched DataWriter entities. These handles match the ones that appear in the 'instance_handle' field of the SampleInfo when reading the “DCPSPublications” builtin topic. The operation may fail if the infrastructure does not locally maintain the connectivity information.

template<typename T >

const dds::topic::SubscriptionBuiltinTopicData dds::sub::matched_publications_data	(	const dds::sub::DataReader< T > &	dw,
		const ::dds::core::InstanceHandle &	h
	)

This operation retrieves information on a publication that is currently associated with the DataReader; that is, a subscription with a matching Topic and compatible QoS that the application has not indicated should be ignored by means of the DomainParticipant ignore_subscription operation. The publication handle must correspond to a publication currently associated with the DataReader, otherwise the operation will fail and throw a BadParameterError. The operation matched_subscriptions can be used to find the subscriptions that are currently matched with the DataWriter.

The operation may also fail if the infrastructure does not hold the information necessary to fill in the subscription_data. In this case the operation will throw UnsupportedError.

dds::sub::functors::MaxSamplesManipulatorFunctor dds::sub::max_samples ( uint32_t n )

inline

template<typename T , template< typename Q > class D>

LoanedSamples<T, D<T> > dds::sub::move ( LoanedSamples< T, D< T > > & a )

dds::sub::functors::NextInstanceManipulatorFunctor dds::sub::next_instance ( const dds::core::InstanceHandle & h )

inline

template<typename SELECTOR >

SELECTOR& dds::sub::read ( SELECTOR & selector )

dds::sub::functors::StateFilterManipulatorFunctor dds::sub::state ( const dds::sub::status::DataState & s )

inline

template<typename SELECTOR >

SELECTOR& dds::sub::take ( SELECTOR & selector )

Namespaces

Classes

Typedefs

Functions

Typedef Documentation

Function Documentation