Public Types | Public Member Functions

ReaderQuery< T > Class Template Reference

#include <ReaderQuery.hpp>

List of all members.

Public Types

typedef
::dds::sub::cond::ReadCondition
< T > 
ReadCondition

Public Member Functions

 ReaderQuery ()
 ~ReaderQuery ()
 ReaderQuery (const ReaderQuery &src)
ReaderQueryoperator= (const ReaderQuery &src)
 ReaderQuery (const ::dds::sub::status::ReaderState &src)
 ReaderQuery (const ReadCondition &src)
 ReaderQuery (const ::dds::core::InstanceHandle &src, bool read_or_take_next=false)
 ReaderQuery (const ::dds::sub::status::ReaderState &state, const ::dds::core::InstanceHandle &handle, bool read_or_take_next=false)
 ReaderQuery (const ReadCondition &cond, const ::dds::core::InstanceHandle &handle, bool read_or_take_next=false)
const dds::core::InstanceHandle instance () const
bool is_read_or_take_next () const
const dds::sub::status::ReaderState reader_state () const
ReadCondition condition () const

Detailed Description

template<typename T>
class dds::sub::ReaderQuery< T >

A ReaderQuery encapsulates the various ways that an application can search for data to read or take from a DataReader.

Definition at line 35 of file ReaderQuery.hpp.


Member Typedef Documentation

Definition at line 38 of file ReaderQuery.hpp.


Constructor & Destructor Documentation

ReaderQuery (  )  [inline]

Definition at line 42 of file ReaderQuery.hpp.

~ReaderQuery (  )  [inline]

Definition at line 48 of file ReaderQuery.hpp.

ReaderQuery ( const ReaderQuery< T > &  src  )  [inline]

Definition at line 52 of file ReaderQuery.hpp.

ReaderQuery ( const ::dds::sub::status::ReaderState src  )  [inline]

Construct a query to read or take samples of all available instances that have the given ReaderState.

Definition at line 72 of file ReaderQuery.hpp.

ReaderQuery ( const ReadCondition src  )  [inline]

Construct a query to read or take samples of all available instances, the availability of which would cause the given ReadCondition or QueryCondition to trigger.

Definition at line 84 of file ReaderQuery.hpp.

ReaderQuery ( const ::dds::core::InstanceHandle src,
bool  read_or_take_next = false 
) [inline]

Construct a query to read or take samples of the identified instance (or the "next" instance), regardless of ReaderState.

Parameters:
read_or_take_next If this flag is set to false (the default), the read or take will return samples of the identified instance. If it is true, the read or take will return samples of the "next" instance in order. This behavior allows applications to easily iterate over the available data one instance at a time.

Definition at line 103 of file ReaderQuery.hpp.

ReaderQuery ( const ::dds::sub::status::ReaderState state,
const ::dds::core::InstanceHandle handle,
bool  read_or_take_next = false 
) [inline]

Construct a query to read or take samples of the identified instance (or the "next" instance) and with the given ReaderState.

Parameters:
read_or_take_next If this flag is set to false (the default), the read or take will return samples of the identified instance. If it is true, the read or take will return samples of the "next" instance in order. This behavior allows applications to easily iterate over the available data one instance at a time.

Definition at line 123 of file ReaderQuery.hpp.

ReaderQuery ( const ReadCondition cond,
const ::dds::core::InstanceHandle handle,
bool  read_or_take_next = false 
) [inline]

Construct a query to read or take samples of the identified instance, the availability of which would cause the given ReadCondition or QueryCondition to trigger.

Parameters:
read_or_take_next If this flag is set to false (the default), the read or take will return samples of the identified instance. If it is true, the read or take will return samples of the "next" instance in order. This behavior allows applications to easily iterate over the available data one instance at a time.

Definition at line 145 of file ReaderQuery.hpp.


Member Function Documentation

ReadCondition condition (  )  const [inline]

The application intends only to read or take those samples, the availability of which would cause the given ReadCondition or QueryCondition to trigger.

Definition at line 194 of file ReaderQuery.hpp.

const dds::core::InstanceHandle instance (  )  const [inline]

If this method returns a non-nil handle, the application intends to read or take only those samples pertaining to the given instance (or the "next" instance). If it returns a nil handle, the application intends to read or take samples pertaining to all available instances.

Definition at line 162 of file ReaderQuery.hpp.

bool is_read_or_take_next (  )  const [inline]

If this flag is set to false, the read or take will return samples of the identified instance. If it is true, the read or take will return samples of the "next" instance in order. This behavior allows applications to easily iterate over the available data one instance at a time.

Definition at line 173 of file ReaderQuery.hpp.

ReaderQuery& operator= ( const ReaderQuery< T > &  src  )  [inline]

Definition at line 59 of file ReaderQuery.hpp.

const dds::sub::status::ReaderState reader_state (  )  const [inline]

The application intends to read or take only those samples with the given ReaderState.

If this ReaderQuery was initialized with a ReadCondition or QueryCondition, this method shall return the ReaderState associated with that condition.

Definition at line 185 of file ReaderQuery.hpp.


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