Defines the filter to create a ContentFilteredTopic.
More...
#include <dds/topic/Filter.hpp>
Public Member Functions |
| Filter (const std::string &filter_expression) |
| Creates a filter with a expression with no parameters.
|
|
template<typename FwdIterator > |
| Filter (const std::string &filter_expression, const FwdIterator ¶ms_begin, const FwdIterator ¶ms_end) |
| Creates a filter with an expression that contains parameters.
|
|
| Filter (const std::string &query_expression, const std::vector< std::string > ¶ms) |
| Creates a filter with an expression that contains parameters.
|
|
const std::string & | expression () const |
| Gets the filter expression.
|
|
const_iterator | begin () const |
| Provides the begin iterator to the parameter list.
|
|
const_iterator | end () const |
| The end iterator to the parameter list.
|
|
iterator | begin () |
| Provides the begin iterator to the parameter list.
|
|
iterator | end () |
| The end iterator to the parameter list.
|
|
template<typename FwdITerator > |
Filter & | parameters (const FwdITerator &begin, const FwdITerator end) |
| Modifies the parameters.
|
|
Filter & | add_parameter (const std::string ¶m) |
| Appends a parameter.
|
|
size_t | parameters_length () const |
| Gets the number of parameters.
|
|
std::string | name () const |
| <<extension>> Gets the filter name
|
|
dds::topic::Filter & | name (const std::string &the_name) |
| <<extension>> Sets a filter name
|
|
Detailed Description
Defines the filter to create a ContentFilteredTopic.
Contains the filter expression and optionally the expression parameters. It also contains the filter name, which allows selecting the filter class to use–by default it's the built-in SQL filter.
Constructor & Destructor Documentation
dds::topic::Filter::Filter |
( |
const std::string & |
filter_expression | ) |
|
|
inline |
template<typename FwdIterator >
dds::topic::Filter::Filter |
( |
const std::string & |
filter_expression, |
|
|
const FwdIterator & |
params_begin, |
|
|
const FwdIterator & |
params_end |
|
) |
| |
|
inline |
Creates a filter with an expression that contains parameters.
- Template Parameters
-
FwdIterator | A forwar iterator whose value type is std::string (or convertible to) |
- Parameters
-
filter_expression | The filter expression |
params_begin | The beginning of the range of expression parameters |
params_end | The end of the range (the number of parameter to create a ContentFilteredTopic can't exceed 100) |
- See Also
- Queries and Filters Syntax
dds::topic::Filter::Filter |
( |
const std::string & |
query_expression, |
|
|
const std::vector< std::string > & |
params |
|
) |
| |
|
inline |
Creates a filter with an expression that contains parameters.
- Parameters
-
query_expression | The query expression |
params | The expression parameters (the number of parameter to create a ContentFilteredTopic can't exceed 100) |
- See Also
- Queries and Filters Syntax
Member Function Documentation
const std::string& dds::topic::Filter::expression |
( |
| ) |
const |
|
inline |
Gets the filter expression.
const_iterator dds::topic::Filter::begin |
( |
| ) |
const |
|
inline |
Provides the begin iterator to the parameter list.
const_iterator dds::topic::Filter::end |
( |
| ) |
const |
|
inline |
The end iterator to the parameter list.
iterator dds::topic::Filter::begin |
( |
| ) |
|
|
inline |
Provides the begin iterator to the parameter list.
iterator dds::topic::Filter::end |
( |
| ) |
|
|
inline |
The end iterator to the parameter list.
template<typename FwdITerator >
Filter& dds::topic::Filter::parameters |
( |
const FwdITerator & |
begin, |
|
|
const FwdITerator |
end |
|
) |
| |
|
inline |
Filter& dds::topic::Filter::add_parameter |
( |
const std::string & |
param | ) |
|
|
inline |
size_t dds::topic::Filter::parameters_length |
( |
| ) |
const |
|
inline |
Gets the number of parameters.
std::string name |
( |
| ) |
const |