RTI Connext Modern C++ API Version 7.2.0
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. More...
 
typedef std::vector< FilterFilterSeq
 A vector of Filter. More...
 

Public Member Functions

 LocatorFilter ()
 Creates the default policy. More...
 
 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. More...
 
LocatorFilterlocator_filters (const FilterSeq &the_locator_filters)
 Sets the locator filters. More...
 
FilterSeq locator_filters () const
 Gets the locator filters. More...
 
LocatorFilterfilter_name (const std::string &the_filter_name)
 Sets the filter name. More...
 
std::string filter_name () const
 Gets the filter name. More...
 

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

◆ Filter

◆ FilterSeq

A vector of Filter.

Constructor & Destructor Documentation

◆ LocatorFilter() [1/2]

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

Creates the default policy.

◆ LocatorFilter() [2/2]

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

◆ locator_filters() [1/2]

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.

◆ locator_filters() [2/2]

FilterSeq rti::core::policy::LocatorFilter::locator_filters ( ) const

Gets the locator filters.

◆ filter_name() [1/2]

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::sql_filter_name and rti::topic::stringmatch_filter_name.

[default] rti::topic::stringmatch_filter_name

References rti::topic::stringmatch_filter_name().

◆ filter_name() [2/2]

std::string rti::core::policy::LocatorFilter::filter_name ( ) const

Gets the filter name.