RTI Routing Service Version 7.1.0
rti::routing::adapter::NoOpStreamReader< Data, Info > Class Template Reference

An empty implementation of the TStreamReader interface. More...

#include <StreamReader.hpp>

Inheritance diagram for rti::routing::adapter::NoOpStreamReader< Data, Info >:
rti::routing::adapter::TStreamReader< Data, Info > rti::routing::adapter::StreamReader rti::routing::UpdatableEntity

Public Member Functions

virtual void take (std::vector< Data * > &, std::vector< Info * > &) RTI_OVERRIDE
 Interface redefinition. More...
 
virtual void read (std::vector< Data * > &, std::vector< Info * > &) RTI_OVERRIDE
 Interface redefinition. More...
 
virtual void take (std::vector< Data * > &, std::vector< Info * > &, const SelectorState &) RTI_OVERRIDE
 Interface redefinition. More...
 
virtual void read (std::vector< Data * > &, std::vector< Info * > &, const SelectorState &) RTI_OVERRIDE
 Interface redefinition. More...
 
virtual void return_loan (std::vector< Data * > &, std::vector< Info * > &) RTI_OVERRIDE
 Interface redefinition. More...
 
virtual void * create_content_query (void *, const dds::topic::Filter &) RTI_OVERRIDE
 Creates a query object that selects the data with the specified filter. More...
 
virtual void delete_content_query (void *) RTI_OVERRIDE
 Deletes a content query created from this StreamReader. More...
 
- Public Member Functions inherited from rti::routing::adapter::TStreamReader< Data, Info >
void take (std::vector< SamplePtr > &sample_seq, std::vector< InfoPtr > &info_seq) RTI_FINAL
 Performs the conversion between the vector of data and info pointers to strongly-type pointers. More...
 
void read (std::vector< SamplePtr > &sample_seq, std::vector< InfoPtr > &info_seq) RTI_FINAL
 Performs the conversion between the vector of data and info pointers to strongly-type pointers. More...
 
void take (std::vector< SamplePtr > &sample_seq, std::vector< InfoPtr > &info_seq, const SelectorState &selector_state) RTI_FINAL
 Performs the conversion between the vector of data and info pointers to strongly-type pointers. More...
 
void read (std::vector< SamplePtr > &sample_seq, std::vector< InfoPtr > &info_seq, const SelectorState &selector_state) RTI_FINAL
 Performs the conversion between the vector of data and info pointers to strongly-type pointers. More...
 
void return_loan (std::vector< SamplePtr > &sample_seq, std::vector< InfoPtr > &info_seq) RTI_FINAL
 Performs the conversion between the vector of data and info pointers to strongly-type pointers. More...
 
virtual void take (std::vector< Data * > &sample_seq, std::vector< Info * > &info_seq)=0
 Interface redefinition. More...
 
virtual void read (std::vector< Data * > &sample_seq, std::vector< Info * > &info_seq)=0
 Interface redefinition. More...
 
virtual void take (std::vector< Data * > &sample_seq, std::vector< Info * > &info_seq, const SelectorState &selector_state)=0
 Interface redefinition. More...
 
virtual void read (std::vector< Data * > &sample_seq, std::vector< Info * > &info_seq, const SelectorState &selector_state)=0
 Interface redefinition. More...
 
virtual void return_loan (std::vector< Data * > &sample_seq, std::vector< Info * > &info_seq)=0
 Interface redefinition. More...
 
virtual void take (std::vector< SamplePtr > &sample_seq, std::vector< InfoPtr > &info_seq)=0
 Takes a collection of all data samples and info samples available from an input stream. More...
 
virtual void take (std::vector< SamplePtr > &sample_seq, std::vector< InfoPtr > &info_seq, const SelectorState &selector_state)=0
 Variation of StreamReader::take where the returned samples shall represent the subset specified by the SelectorState. More...
 
virtual void read (std::vector< SamplePtr > &sample_seq, std::vector< InfoPtr > &info_seq)=0
 Variation of StreamReader::take where the returned samples will remain in the StreamReader's cache, so they can be read again by subsequence StreamReader::take or StreamReader::read operations. More...
 
virtual void read (std::vector< SamplePtr > &sample_seq, std::vector< InfoPtr > &info_seq, const SelectorState &selector_state)=0
 Variation of StreamReader::read where the returned samples shall represent the subset specified by the SelectorState. More...
 
virtual void return_loan (std::vector< SamplePtr > &sample_seq, std::vector< InfoPtr > &info_seq)=0
 Returns a loan on the read or taken data samples and info samples. More...
 
- Public Member Functions inherited from rti::routing::adapter::StreamReader
virtual void take (std::vector< SamplePtr > &sample_seq, std::vector< InfoPtr > &info_seq)=0
 Takes a collection of all data samples and info samples available from an input stream. More...
 
virtual void read (std::vector< SamplePtr > &sample_seq, std::vector< InfoPtr > &info_seq)=0
 Variation of StreamReader::take where the returned samples will remain in the StreamReader's cache, so they can be read again by subsequence StreamReader::take or StreamReader::read operations. More...
 
virtual void take (std::vector< SamplePtr > &sample_seq, std::vector< InfoPtr > &info_seq, const SelectorState &selector_state)=0
 Variation of StreamReader::take where the returned samples shall represent the subset specified by the SelectorState. More...
 
virtual void read (std::vector< SamplePtr > &sample_seq, std::vector< InfoPtr > &info_seq, const SelectorState &selector_state)=0
 Variation of StreamReader::read where the returned samples shall represent the subset specified by the SelectorState. More...
 
virtual void return_loan (std::vector< SamplePtr > &sample_seq, std::vector< InfoPtr > &info_seq)=0
 Returns a loan on the read or taken data samples and info samples. More...
 
virtual void * create_content_query (void *old_query_data, const dds::topic::Filter &filter)=0
 Creates a query object that selects the data with the specified filter. More...
 
virtual void delete_content_query (void *query_data)=0
 Deletes a content query created from this StreamReader. More...
 
virtual ~StreamReader ()
 Virtual destructor. More...
 
- Public Member Functions inherited from rti::routing::UpdatableEntity
virtual void update (const std::map< std::string, std::string > &properties)
 Updates a pluggable entity. More...
 
virtual ~UpdatableEntity ()
 Virtual destructor. More...
 

Additional Inherited Members

- Public Types inherited from rti::routing::adapter::TStreamReader< Data, Info >
typedef Data DataRep
 The data type. More...
 
typedef Info InfoRep
 The info type. More...
 

Detailed Description

template<typename Data, typename Info>
class rti::routing::adapter::NoOpStreamReader< Data, Info >

An empty implementation of the TStreamReader interface.

Each implemented operation performs as a no-op.

Member Function Documentation

◆ take() [1/2]

template<typename Data , typename Info >
virtual void rti::routing::adapter::NoOpStreamReader< Data, Info >::take ( std::vector< Data * > &  sample_seq,
std::vector< Info * > &  info_seq 
)
inlinevirtual

Interface redefinition.

See also
StreamReader::take

Implements rti::routing::adapter::TStreamReader< Data, Info >.

◆ read() [1/2]

template<typename Data , typename Info >
virtual void rti::routing::adapter::NoOpStreamReader< Data, Info >::read ( std::vector< Data * > &  sample_seq,
std::vector< Info * > &  info_seq 
)
inlinevirtual

Interface redefinition.

See also
StreamReader::read

Implements rti::routing::adapter::TStreamReader< Data, Info >.

◆ take() [2/2]

template<typename Data , typename Info >
virtual void rti::routing::adapter::NoOpStreamReader< Data, Info >::take ( std::vector< Data * > &  sample_seq,
std::vector< Info * > &  info_seq,
const SelectorState selector_state 
)
inlinevirtual

Interface redefinition.

See also
StreamReader::take(std::vector&, std::vector&,const SelectorState&);

Implements rti::routing::adapter::TStreamReader< Data, Info >.

◆ read() [2/2]

template<typename Data , typename Info >
virtual void rti::routing::adapter::NoOpStreamReader< Data, Info >::read ( std::vector< Data * > &  sample_seq,
std::vector< Info * > &  info_seq,
const SelectorState selector_state 
)
inlinevirtual

Interface redefinition.

See also
StreamReader::read(std::vector&, std::vector&,const SelectorState&);

Implements rti::routing::adapter::TStreamReader< Data, Info >.

◆ return_loan()

template<typename Data , typename Info >
virtual void rti::routing::adapter::NoOpStreamReader< Data, Info >::return_loan ( std::vector< Data * > &  sample_seq,
std::vector< Info * > &  info_seq 
)
inlinevirtual

◆ create_content_query()

template<typename Data , typename Info >
virtual void * rti::routing::adapter::NoOpStreamReader< Data, Info >::create_content_query ( void *  old_query_data,
const dds::topic::Filter &  filter 
)
inlinevirtual

Creates a query object that selects the data with the specified filter.

This operation allows to read data with a SelectorState that contains a query object returned by this operation.

A query object type is implementation dependent and it's guaranteed to to be used only within the same StreamReader that created it. Because a query object may be a expensive resource, this operation allows to receive a previously created query for a potential reuse and update of its filter.

Parameters
[in]old_query_dataA previously created query object that that is provided for potential reuse and update of its filter.
[in]filterThe query content filter
Returns
The new or updated query object.
Exceptions
std::exception

Implements rti::routing::adapter::StreamReader.

◆ delete_content_query()

template<typename Data , typename Info >
virtual void rti::routing::adapter::NoOpStreamReader< Data, Info >::delete_content_query ( void *  query_data)
inlinevirtual

Deletes a content query created from this StreamReader.

Parameters
[in]query_datathe query object to be deleted.

Implements rti::routing::adapter::StreamReader.