rti::core::policy::LocatorFilter Class Reference

<<extension>> Configures how the dds::topic::PublicationBuiltinTopicData reports the configuration of a MultiChannel DataWriter. More...

#include <rti/core/policy/CorePolicy.hpp>

Public Types
typedef rti::core::LocatorFilterElement	Filter
	A LocatorFilter policy is a collection of LocatorFilterElement.
typedef std::vector< Filter >	FilterSeq
	A vector of Filter.

Public Member Functions
	LocatorFilter ()
	Creates the default policy.
	LocatorFilter (const FilterSeq &the_locator_filters, const std::string &the_filter_name=rti::topic::stringmatch_filter_name())
	Creates an instance with a sequence of filters and a filter name.
LocatorFilter &	locator_filters (const FilterSeq &the_locator_filters)
	Sets the locator filters.
FilterSeq	locator_filters () const
	Gets the locator filters.
LocatorFilter &	filter_name (const std::string &the_filter_name)
	Sets the filter name.
std::string	filter_name () const
	Gets the filter name.

Detailed Description

<<extension>> Configures how the dds::topic::PublicationBuiltinTopicData reports the configuration of a MultiChannel DataWriter.

Entity:

dds::topic::PublicationBuiltinTopicData

Properties:

RxO = N/A
Changeable = NO

Member Typedef Documentation

typedef rti::core::LocatorFilterElement rti::core::policy::LocatorFilter::Filter

A LocatorFilter policy is a collection of LocatorFilterElement.

typedef std::vector<Filter> rti::core::policy::LocatorFilter::FilterSeq

A vector of Filter.

Constructor & Destructor Documentation

rti::core::policy::LocatorFilter::LocatorFilter ( )

inline

Creates the default policy.

rti::core::policy::LocatorFilter::LocatorFilter ( const FilterSeq &  the_locator_filters, const std::string &  the_filter_name = rti::topic::stringmatch_filter_name()  )

inline

Creates an instance with a sequence of filters and a filter name.

Member Function Documentation

LocatorFilter& rti::core::policy::LocatorFilter::locator_filters

(

const FilterSeq &

the_locator_filters

)

Sets the locator filters.

A sequence length of zero indicates the rti::core::policy::MultiChannel is not in use.

[default] Empty sequence.

FilterSeq rti::core::policy::LocatorFilter::locator_filters

(

)

const

Gets the locator filters.

LocatorFilter& rti::core::policy::LocatorFilter::filter_name

(

const std::string &

the_filter_name

)

Sets the filter name.

The following builtin filters are supported: rti::topic::SQLFILTER_NAME and rti::topic::STRINGMATCHFILTER_NAME.

[default] rti::topic::STRINGMATCHFILTER_NAME

std::string rti::core::policy::LocatorFilter::filter_name

(

)

const

Gets the filter name.