rti::topic::ExpressionProperty Class Reference

<<extension>> <<value-type>> Provides additional information about the filter expression passed to the writer_compile method of rti::topic::WriterContentFilter More...

#include <rti/topic/ContentFilter.hpp>

Public Member Functions
	ExpressionProperty ()
	Create a default ExpressionProperty with key_only_filter = false and writer_side_filter_optimization = false.
	ExpressionProperty (bool the_key_only_filter, bool the_writer_side_filter_optimization)
	Create an ExpressionProperty with the provided key_only_filter, and writer_side_filter_optimization.
bool	key_only_filter () const
	Get the value of key_only_filter.
ExpressionProperty &	key_only_filter (bool the_key_only_filter)
	Set the value for key_only_filter, indicating if the filter expression is based only on key fields. In this case, RTI Connext itself can cache the filtering results.
bool	writer_side_filter_optimization () const
	Get the value of writer_side_filter_optimization.
ExpressionProperty &	writer_side_filter_optimization (bool the_writer_side_filter_optimization)
	Set the value for writer_side_filter_optimization, indicating if the filter implementation can cache the filtering result for the provided expression.

Detailed Description

<<extension>> <<value-type>> Provides additional information about the filter expression passed to the writer_compile method of rti::topic::WriterContentFilter

It is used by the filter implementation to indicate to the middleware whether or not the WriterContentFilter will cache the result of filter evaluation.

See Also

rti::topic::WriterContentFilter

Constructor & Destructor Documentation

rti::topic::ExpressionProperty::ExpressionProperty ( )

inline

Create a default ExpressionProperty with key_only_filter = false and writer_side_filter_optimization = false.

rti::topic::ExpressionProperty::ExpressionProperty ( bool  the_key_only_filter, bool  the_writer_side_filter_optimization  )

inline

Create an ExpressionProperty with the provided key_only_filter, and writer_side_filter_optimization.

Parameters

the_key_only_filter	The value for key_only_filter
the_writer_side_filter_optimization	The value for writer_side_filter_optimization

Member Function Documentation

bool rti::topic::ExpressionProperty::key_only_filter ( ) const

inline

Get the value of key_only_filter.

See Also

key_only_filter(bool the_key_only_filter)

ExpressionProperty& rti::topic::ExpressionProperty::key_only_filter ( bool  the_key_only_filter )

inline

Set the value for key_only_filter, indicating if the filter expression is based only on key fields. In this case, RTI Connext itself can cache the filtering results.

When this field is set to true, it indicates to RTI Connext that the filter expression is based only on key fields.

Parameters

the_key_only_filter

The value to set for key_only_filter

bool rti::topic::ExpressionProperty::writer_side_filter_optimization ( ) const

inline

Get the value of writer_side_filter_optimization.

See Also

writer_side_filter_optimization(bool the_writer_side_filter_optimization)

ExpressionProperty& rti::topic::ExpressionProperty::writer_side_filter_optimization ( bool  the_writer_side_filter_optimization )

inline

Set the value for writer_side_filter_optimization, indicating if the filter implementation can cache the filtering result for the provided expression.

When this field is set to true, RTI Connext will do no caching or explicit filter evaluation for the associated dds::sub::DataReader. Instead, it will rely on the filter implementation to provide appropriate results.

Parameters

the_writer_side_filter_optimization

The value to set for writer_side_filter_optimization