RTI Connext Modern C++ API Version 7.2.0
rti::core::LocatorFilterElement Class Reference

<<extension>> <<value-type>> Specifies the configuration of an individual channel within a MultiChannel DataWriter. More...

#include <LocatorFilter.hpp>

Public Member Functions

 LocatorFilterElement (const std::string &the_filter_expression, const rti::core::LocatorSeq &the_locators)
 Creates an instance with the provided filter_expression and locators. More...
 
rti::core::LocatorSeq locators () const
 Get the locators associated with this filter. More...
 
LocatorFilterElementlocators (const LocatorSeq &the_locators)
 Set the locators associated with this LocatorFilterImpl. More...
 
std::string filter_expression () const
 Get the filter expression. More...
 
LocatorFilterElementfilter_expression (const std::string &the_expression)
 Set the filter expression. More...
 

Detailed Description

<<extension>> <<value-type>> Specifies the configuration of an individual channel within a MultiChannel DataWriter.

See also
dds::core::policy::LocatorFilter

Constructor & Destructor Documentation

◆ LocatorFilterElement()

rti::core::LocatorFilterElement::LocatorFilterElement ( const std::string &  the_filter_expression,
const rti::core::LocatorSeq &  the_locators 
)
inline

Creates an instance with the provided filter_expression and locators.

Parameters
the_filter_expressionA logical expression used to determine the data that will be published in the channel.
the_locatorsSequence containing from one to four rti::core::Locator

Member Function Documentation

◆ locators() [1/2]

rti::core::LocatorSeq rti::core::LocatorFilterElement::locators ( ) const
inline

Get the locators associated with this filter.

The locators are a sequence containing from one to four rti::core::Locator, used to specify the multicast address locators of an individual channel within a MultiChannel DataWriter.

◆ locators() [2/2]

LocatorFilterElement & rti::core::LocatorFilterElement::locators ( const LocatorSeq &  the_locators)
inline

Set the locators associated with this LocatorFilterImpl.

◆ filter_expression() [1/2]

std::string rti::core::LocatorFilterElement::filter_expression ( ) const
inline

Get the filter expression.

◆ filter_expression() [2/2]

LocatorFilterElement & rti::core::LocatorFilterElement::filter_expression ( const std::string &  the_expression)
inline

Set the filter expression.

The filter expression is a logical expression used to determine the data that will be published in the channel.

If the expression evaluates to TRUE, a sample will be published on the channel.

An empty string always evaluates the expression to TRUE.

The syntax of the expression will depend on the value of rti::core::policy::LocatorFilter::filter_name

See also
Queries and Filters Syntax

[default] NULL (invalid value)