RTI Connext Modern C++ API  Version 6.0.0
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
rti::sub::TopicQuerySelection Class Reference

<<extension>> <<value-type>> Specifies the data query that defines a TopicQuery. More...

#include <rti/sub/TopicQuery.hpp>

Public Types

typedef TopicQuerySelectionKind Kind
 Alias for TopicQuerySelectionKind.
 

Public Member Functions

 TopicQuerySelection (const dds::topic::Filter &the_filter)
 Creates a TopicQuerySelection.
 
 TopicQuerySelection (const dds::topic::Filter &the_filter, Kind the_kind)
 Creates a TopicQuerySelection with a selection kind.
 
dds::topic::Filterfilter ()
 Gets the filter.
 
const dds::topic::Filterfilter () const
 Gets the filter.
 
Kind kind () const
 Gets the selection kind.
 
TopicQuerySelectionkind (Kind the_kind)
 Indicates whether the sample selection is limited to cached samples or not.
 

Detailed Description

<<extension>> <<value-type>> Specifies the data query that defines a TopicQuery.

A TopicQuerySelection is defined by a dds::topic::Filter that selects a subset of samples in the dds::pub::DataWriters

Member Typedef Documentation

Alias for TopicQuerySelectionKind.

Constructor & Destructor Documentation

rti::sub::TopicQuerySelection::TopicQuerySelection ( const dds::topic::Filter the_filter)
inlineexplicit

Creates a TopicQuerySelection.

Parameters
the_filterDefines the data query
Note
The filter expression can start with the special condition "@instance_state = ALIVE AND" followed by the rest of the expression. This restricts the selection to samples of alive instances.
See Also
TopicQuery::SelectAll()
TopicQuery::UseReaderContentFilter()
rti::sub::TopicQuerySelection::TopicQuerySelection ( const dds::topic::Filter the_filter,
Kind  the_kind 
)
inline

Creates a TopicQuerySelection with a selection kind.

Parameters
the_filterDefines the data query
the_kindIndicates the kind of selection

Member Function Documentation

dds::topic::Filter& rti::sub::TopicQuerySelection::filter ( )
inline

Gets the filter.

const dds::topic::Filter& rti::sub::TopicQuerySelection::filter ( ) const
inline

Gets the filter.

Kind rti::sub::TopicQuerySelection::kind ( ) const
inline

Gets the selection kind.

TopicQuerySelection& rti::sub::TopicQuerySelection::kind ( Kind  the_kind)
inline

Indicates whether the sample selection is limited to cached samples or not.

[default] rti::sub::TopicQuerySelectionKind::HISTORY_SNAPSHOT


RTI Connext Modern C++ API Version 6.0.0 Copyright © Sun Mar 3 2019 Real-Time Innovations, Inc