RTI Connext Modern C++ API
Version 6.1.0
|
<<reference-type>> Specialized ReadCondition that allows applications to also specify a filter on the data available in a dds::sub::DataReader More...
#include <dds/sub/cond/QueryCondition.hpp>
Public Types | |
typedef DELEGATE::iterator | iterator |
Parameter iterator. A random-access iterator of std::string. More... | |
typedef DELEGATE::const_iterator | const_iterator |
Parameter iterator. A random-access iterator of std::string. More... | |
Public Member Functions | |
QueryCondition (const dds::sub::Query &query, const dds::sub::status::DataState &status) | |
Creates a QueryCondition. More... | |
template<typename Functor > | |
QueryCondition (const dds::sub::Query &query, const dds::sub::status::DataState &status, const Functor &functor) | |
Creates a QueryCondition with a handler. More... | |
std::string | expression () const |
Gets the expression. More... | |
dds::core::StringSeq | parameters () const |
Gets the parameters. More... | |
template<typename FWIterator > | |
void | parameters (const FWIterator &begin, const FWIterator &end) |
Modifies the query parameters. More... | |
uint32_t | parameters_length () const |
Gets the number of parameters. More... | |
void | parameters (const dds::core::StringSeq ¶meters) |
<<extension>> Set the parameters More... | |
![]() | |
template<typename T > | |
ReadCondition (const dds::sub::DataReader< T > &reader, const dds::sub::status::DataState &status) | |
Creates a ReadCondition. More... | |
template<typename T , typename Functor > | |
ReadCondition (const dds::sub::DataReader< T > &reader, const dds::sub::status::DataState &status, const Functor &handler) | |
Creates a ReadCondition with a handler. More... | |
const dds::sub::status::DataState | state_filter () const |
Returns the DataState of this condition. More... | |
const AnyDataReader & | data_reader () const |
Returns the DataReader associated to this condition. More... | |
void | close () |
Closes the ReadCondition. More... | |
bool | closed () const |
Indicates whether this ReadCondition has been closed with close(). More... | |
![]() | |
void | dispatch () |
Dispatches the functors that have been registered with the condition. More... | |
bool | trigger_value () const |
This operation retrieves the trigger_value of the Condition. More... | |
Additional Inherited Members | |
![]() | |
dds::sub::cond::detail::ReadCondition | create_read_condition_ex (const dds::sub::AnyDataReader &reader, const ::rti::sub::status::DataStateEx &status) |
<<extension>> Creates a ReadCondition with the extended DataStateEx. More... | |
template<typename Functor > | |
dds::sub::cond::detail::ReadCondition | create_read_condition_ex (const dds::sub::AnyDataReader &reader, const ::rti::sub::status::DataStateEx &status, const Functor &handler) |
<<extension>> Creates a ReadCondition with the extended DataStateEx and a handler. More... | |
<<reference-type>> Specialized ReadCondition that allows applications to also specify a filter on the data available in a dds::sub::DataReader
Each query condition filter is composed of a dds::sub::cond::ReadCondition state filter and a content filter expressed as a query_expression
and query_parameters
.
The query (query_expression
) is similar to an SQL WHERE clause and can be parameterised by arguments that are dynamically changeable by the set_query_parameters() operation.
Two query conditions that have the same query_expression
will require unique query condition content filters if their query_paramters
differ. Query conditions that differ only in their state masks will share the same query condition content filter.
Queries and Filters Syntax describes the syntax of query_expression
and query_parameters
.
typedef DELEGATE::iterator dds::sub::cond::QueryCondition::iterator |
Parameter iterator. A random-access iterator of std::string.
typedef DELEGATE::const_iterator dds::sub::cond::QueryCondition::const_iterator |
Parameter iterator. A random-access iterator of std::string.
|
inline |
Creates a QueryCondition.
query | The query |
status | The sample, view and instance states of interest. |
|
inline |
Creates a QueryCondition with a handler.
This constructor is similar to this ReadCondition constructor.
|
inline |
Gets the expression.
|
inline |
Gets the parameters.
Provides the begin iterator to the parameter list. The end iterator to the parameter list. Provides the begin iterator to the parameter list. The end iterator to the parameter list.
|
inline |
Modifies the query parameters.
FWIterator | A forward iterator whose value type is std::string (or convertible to std::string). |
begin | The beginning of the range of parameters |
end | The end of the range |
|
inline |
Gets the number of parameters.
void parameters | ( | const dds::core::StringSeq & | parameters | ) |
<<extension>> Set the parameters