Public Types | Public Member Functions

DataReader< T, DELEGATE > Class Template Reference

#include <DataReader.hpp>

Inheritance diagram for DataReader< T, DELEGATE >:

List of all members.

Public Types

typedef DELEGATE< T > DELEGATE_T
typedef
::dds::core::smart_ptr_traits
< DELEGATE< T > >::ref_type 		DELEGATE_REF_T
typedef
::dds::core::smart_ptr_traits
< DELEGATE< T >
>::weak_ref_type 		DELEGATE_WEAK_REF_T
typedef tdds::core::Entity
< DELEGATE< T > > 		BASE_T
typedef T DataType
typedef ::dds::sub::Sample< T > Sample
typedef
::dds::sub::LoanedSamples< T > 		LoanedSamples
typedef
::dds::sub::DataReaderListener
< DataType > 		Listener
typedef
::dds::core::cond::StatusCondition
< DataReader > 		StatusCondition
typedef
::dds::sub::cond::ReadCondition
< DataType > 		ReadCondition
typedef
::dds::sub::cond::QueryCondition
< DataType > 		QueryCondition
typedef
::dds::sub::ReaderQuery
< DataType > 		ReaderQuery

Public Member Functions

template<typename T__ >
DataReader & operator= (const T__ &rhs)
 DataReader (DELEGATE_T *p)
 DataReader (const DELEGATE_REF_T &ref)
template<typename H__ >
 DataReader (const H__ &h)
 DataReader ()
 ~DataReader ()
StatusCondition status_condition () const
dds::sub::status::ReaderState default_read_state ()
void default_read_state (const dds::sub::status::ReaderState &rs)
DataReader & operator>> (dds::sub::LoanedSamples< T > &ls)
LoanedSamples read ()
LoanedSamples read (const ReaderQuery &query)
LoanedSamples take ()
LoanedSamples take (const ReaderQuery &query)
template<typename SamplesFWIterator , typename InfoFWIterator >
void read (SamplesFWIterator sfit, InfoFWIterator ifit, size_t max_samples)
template<typename SamplesFWIterator , typename InfoFWIterator >
void read (SamplesFWIterator sfit, InfoFWIterator ifit, size_t max_samples, const ReaderQuery &query)
template<typename SamplesFWIterator , typename InfoFWIterator >
void take (SamplesFWIterator sfit, InfoFWIterator ifit, size_t max_samples)
template<typename SamplesFWIterator , typename InfoFWIterator >
void take (SamplesFWIterator sfit, InfoFWIterator ifit, size_t max_samples, const ReaderQuery &query)
template<typename SamplesBIIterator , typename InfoBIIterator >
void read (SamplesBIIterator sbit, InfoBIIterator ibit)
template<typename SamplesBIIterator , typename InfoBIIterator >
void read (SamplesBIIterator sbit, InfoBIIterator ibit, const ReaderQuery &query)
template<typename SamplesBIIterator , typename InfoBIIterator >
void take (SamplesBIIterator sbit, InfoBIIterator ibit)
template<typename SamplesBIIterator , typename InfoBIIterator >
void take (SamplesBIIterator sbit, InfoBIIterator ibit, const ReaderQuery &query)
dds::topic::TopicInstance< T > & key_value (dds::topic::TopicInstance< T > &i, const dds::core::InstanceHandle &h)
T & key_value (T &sample, const dds::core::InstanceHandle &h)
const dds::core::InstanceHandle lookup_instance (const T &key)
dds::topic::TopicDescription
< DataType > 		topic_description ()
void listener (Listener *the_listener, const dds::core::status::StatusMask &event_mask)
Listener * listener () const
const dds::sub::qos::DataReaderQos qos () const
void qos (const dds::sub::qos::DataReaderQos &the_qos)
DataReader & operator<< (const dds::sub::qos::DataReaderQos &the_qos)
DataReader & operator>> (dds::sub::qos::DataReaderQos &the_qos)
void wait_for_historical_data (const dds::core::Duration &timeout)
ReadCondition create_readcondition (const dds::sub::status::ReaderState &read_state=dds::sub::status::ReaderState::any())
QueryCondition create_querycondition (const std::string &query_expression, const dds::core::StringSeq &query_parameters, const dds::sub::status::ReaderState &read_state=dds::sub::status::ReaderState::any())

Detailed Description

template<typename T, template< typename Q > class DELEGATE>
class dds::sub::DataReader< T, DELEGATE >

Definition at line 38 of file DataReader.hpp.

Member Typedef Documentation

typedef tdds::core::Entity< DELEGATE<T> > BASE_T

Reimplemented from Entity< DELEGATE< T > >.

Definition at line 40 of file DataReader.hpp.

typedef T DataType

Definition at line 43 of file DataReader.hpp.

typedef ::dds::core::smart_ptr_traits< DELEGATE<T> >::ref_type DELEGATE_REF_T

Reimplemented from Entity< DELEGATE< T > >.

Definition at line 40 of file DataReader.hpp.

typedef DELEGATE<T> DELEGATE_T

Reimplemented from Entity< DELEGATE< T > >.

Definition at line 40 of file DataReader.hpp.

typedef ::dds::core::smart_ptr_traits< DELEGATE<T> >::weak_ref_type DELEGATE_WEAK_REF_T

Reimplemented from Entity< DELEGATE< T > >.

Definition at line 40 of file DataReader.hpp.

typedef ::dds::sub::DataReaderListener<DataType> Listener

Definition at line 46 of file DataReader.hpp.

typedef ::dds::sub::LoanedSamples<T> LoanedSamples

Definition at line 45 of file DataReader.hpp.

typedef ::dds::sub::cond::QueryCondition<DataType> QueryCondition

Definition at line 49 of file DataReader.hpp.

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

Definition at line 48 of file DataReader.hpp.

typedef ::dds::sub::ReaderQuery<DataType> ReaderQuery

Definition at line 50 of file DataReader.hpp.

typedef ::dds::sub::Sample<T> Sample

Definition at line 44 of file DataReader.hpp.

typedef ::dds::core::cond::StatusCondition<DataReader> StatusCondition

Definition at line 47 of file DataReader.hpp.

Constructor & Destructor Documentation

DataReader ( DELEGATE_T *  p  )  [inline, explicit]

Definition at line 40 of file DataReader.hpp.

DataReader ( const DELEGATE_REF_T &  ref  )  [inline, explicit]

Definition at line 40 of file DataReader.hpp.

DataReader ( const H__ &  h  )  [inline]

Definition at line 40 of file DataReader.hpp.

DataReader (  )  [inline]

Definition at line 40 of file DataReader.hpp.

~DataReader (  )  [inline]

Definition at line 53 of file DataReader.hpp.

Member Function Documentation

QueryCondition create_querycondition ( const std::string &  query_expression,
const dds::core::StringSeq &  query_parameters,
const dds::sub::status::ReaderState &  read_state = dds::sub::status::ReaderState::any() 
) [inline]

Definition at line 283 of file DataReader.hpp.

ReadCondition create_readcondition ( const dds::sub::status::ReaderState &  read_state = dds::sub::status::ReaderState::any()  )  [inline]

Definition at line 274 of file DataReader.hpp.

void default_read_state ( const dds::sub::status::ReaderState &  rs  )  [inline]

Definition at line 79 of file DataReader.hpp.

dds::sub::status::ReaderState default_read_state (  )  [inline]

Returns the default read-state (if not changed, it is set to ReaderState::any()).

Definition at line 76 of file DataReader.hpp.

dds::topic::TopicInstance<T>& key_value ( dds::topic::TopicInstance< T > &  i,
const dds::core::InstanceHandle &  h 
) [inline]

This operation can be used to retrieve the instance key that corresponds to an instance_handle. The operation will only fill the fields that form the key inside the key_holder instance. This operation may raise a BadParameter exception if the InstanceHandle does not correspond to an existing data-object known to the DataWriter. If the implementation is not able to check invalid handles, then the result in this situation is unspecified.

Definition at line 203 of file DataReader.hpp.

T& key_value ( T &  sample,
const dds::core::InstanceHandle &  h 
) [inline]

This operation can be used to retrieve the instance key that corresponds to an instance_handle. The operation will only fill the fields that form the key inside the key_holder instance. This operation may raise a BadParameter exception if the InstanceHandle does not correspond to an existing data-object known to the DataWriter. If the implementation is not able to check invalid handles, then the result in this situation is unspecified.

Definition at line 217 of file DataReader.hpp.

void listener ( Listener *  the_listener,
const dds::core::status::StatusMask &  event_mask 
)
Listener* listener (  )  const
const dds::core::InstanceHandle lookup_instance ( const T &  key  )  [inline]

This operation takes as a parameter an instance and returns a handle that can be used in subsequent operations that accept an instance handle as an argument. The instance parameter is only used for the purpose of examining the fields that define the key. This operation does not register the instance in question. If the instance has not been previously registered, or if for any other reason the Service is unable to provide an instance handle, the Service will return a TopicInstance whose handle will be set to the HANDLE_NIL value.

Definition at line 231 of file DataReader.hpp.

DataReader& operator<< ( const dds::sub::qos::DataReaderQos &  the_qos  )  [inline]

Definition at line 257 of file DataReader.hpp.

DataReader& operator= ( const T__ &  rhs  )  [inline]

Reimplemented from Entity< DELEGATE< T > >.

Definition at line 40 of file DataReader.hpp.

DataReader& operator>> ( dds::sub::LoanedSamples< T > &  ls  )  [inline]

Manipulators are defined externally to make it possible to control whether the streaming operators reads or takes. dr >> read >> loanedSamples; dr >> take >> loanedSamples;

Definition at line 91 of file DataReader.hpp.

DataReader& operator>> ( dds::sub::qos::DataReaderQos &  the_qos  )  [inline]

Definition at line 262 of file DataReader.hpp.

const dds::sub::qos::DataReaderQos qos (  )  const [inline]

Definition at line 249 of file DataReader.hpp.

void qos ( const dds::sub::qos::DataReaderQos &  the_qos  )  [inline]

Definition at line 253 of file DataReader.hpp.

void read ( SamplesBIIterator  sbit,
InfoBIIterator  ibit 
) [inline]

Definition at line 158 of file DataReader.hpp.

void read ( SamplesBIIterator  sbit,
InfoBIIterator  ibit,
const ReaderQuery &  query 
) [inline]

Definition at line 166 of file DataReader.hpp.

void read ( SamplesFWIterator  sfit,
InfoFWIterator  ifit,
size_t  max_samples 
) [inline]

Definition at line 119 of file DataReader.hpp.

LoanedSamples read (  )  [inline]

Definition at line 98 of file DataReader.hpp.

void read ( SamplesFWIterator  sfit,
InfoFWIterator  ifit,
size_t  max_samples,
const ReaderQuery &  query 
) [inline]

Definition at line 128 of file DataReader.hpp.

LoanedSamples read ( const ReaderQuery &  query  )  [inline]

Definition at line 102 of file DataReader.hpp.

StatusCondition status_condition (  )  const [inline]

This operation allows access to the StatusCondition (Section 7.1.2.1.9, âStatusCondition Class) associated with the Entity. The returned condition can then be added to a WaitSet (Section 7.1.2.1.6, WaitSet Class) so that the application can wait for specific status changes that affect the Entity.

Returns:
the status condition

Definition at line 65 of file DataReader.hpp.

LoanedSamples take ( const ReaderQuery &  query  )  [inline]

Definition at line 110 of file DataReader.hpp.

void take ( SamplesFWIterator  sfit,
InfoFWIterator  ifit,
size_t  max_samples 
) [inline]

Definition at line 138 of file DataReader.hpp.

LoanedSamples take (  )  [inline]

Definition at line 106 of file DataReader.hpp.

void take ( SamplesBIIterator  sbit,
InfoBIIterator  ibit,
const ReaderQuery &  query 
) [inline]

Definition at line 184 of file DataReader.hpp.

void take ( SamplesFWIterator  sfit,
InfoFWIterator  ifit,
size_t  max_samples,
const ReaderQuery &  query 
) [inline]

Definition at line 147 of file DataReader.hpp.

void take ( SamplesBIIterator  sbit,
InfoBIIterator  ibit 
) [inline]

Definition at line 176 of file DataReader.hpp.

dds::topic::TopicDescription<DataType> topic_description (  ) 
void wait_for_historical_data ( const dds::core::Duration &  timeout  )  [inline]

Definition at line 268 of file DataReader.hpp.

The documentation for this class was generated from the following file:
Generated on Tue Nov 9 2010 02:16:24 for dds-psm-cxx-doc by  doxygen 1.7.1