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.
rti::core::LocatorSeq	locators () const
	Get the locators associated with this filter.
LocatorFilterElement &	locators (const LocatorSeq &the_locators)
	Set the locators associated with this LocatorFilterImpl.
std::string	filter_expression () const
	Get the filter expression.
LocatorFilterElement &	filter_expression (const std::string &the_expression)
	Set the filter expression.

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

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_expression	A logical expression used to determine the data that will be published in the channel.
the_locators	Sequence containing from one to four rti::core::Locator

Member Function Documentation

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.

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

inline

Set the locators associated with this LocatorFilterImpl.

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

inline

Get the filter expression.

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)