rti::topic::CustomFilter< T > Class Template Reference

<<extension>> <<reference-type>> A wrapper class for the user-defined implementation of a ContentFilter. More...

#include <rti/topic/CustomFilter.hpp>

Inherits dds::core::Reference< DELEGATE >.

Public Member Functions
	CustomFilter (typename dds::core::smart_ptr_traits< T >::ref_type content_filter_ref)
	Create a CustomFilter which holds a shared pointer to a user-defined content filter.
const T *	get () const
	Get a const pointer to the underlying content filter.
T *	get ()
	Get a pointer to the underlying content filter.
Public Member Functions inherited from dds::core::Reference< DELEGATE >
	Reference (dds::core::null_type &)
	Reference (const Reference &ref)
template<typename D >
	Reference (const Reference< D > &ref)
	~Reference ()
template<typename R >
bool	operator== (const R &ref) const
template<typename R >
bool	operator!= (const R &ref) const
Reference &	operator= (const null_type)
bool	is_nil () const
bool	operator== (const null_type) const
bool	operator!= (const null_type) const
const DELEGATE_REF_T &	delegate () const OMG_NOEXCEPT
DELEGATE_REF_T &	delegate () OMG_NOEXCEPT
DELEGATE *	operator-> () OMG_NOEXCEPT
const DELEGATE *	operator-> () const OMG_NOEXCEPT

Detailed Description

template<typename T>
class rti::topic::CustomFilter< T >

<<extension>> <<reference-type>> A wrapper class for the user-defined implementation of a ContentFilter.

In order to register a custom content filter a user must:

• Implement the content filter by creating their own class which inherits from one of the abstract classes: ContentFilter, WriterContentFilter, or WriterContentFilterHelper
• Create a CustomFilter which holds a shared pointer to the user-defined content filter
• Register the CustomFilter with the dds::domain::DomainParticipant using dds::domain::DomainParticipant::register_contentfilter

The CustomFilter class prevents your content filter from being deleted while RTI Connext is using your filter by retaining a reference to your filter until it is no longer being used by RTI Connext.

For an example of how to create anad register a custom content filter see Creating Custom Content Filters.

Template Parameters

T	The type of the custom content filter that is being registered. It must be a type which inherits and implements the interface of one of ContentFilter, WriterContentFilter, or WriterContentFilterHelper

Constructor & Destructor Documentation

template<typename T>

rti::topic::CustomFilter< T >::CustomFilter ( typename dds::core::smart_ptr_traits< T >::ref_type  content_filter_ref )

inline

Create a CustomFilter which holds a shared pointer to a user-defined content filter.

Parameters

content_filter_ref

A shared pointer to a user-defined content filter object.

Member Function Documentation

template<typename T>

const T* rti::topic::CustomFilter< T >::get ( ) const

inline

Get a const pointer to the underlying content filter.

template<typename T>

T* rti::topic::CustomFilter< T >::get ( )

inline

Get a pointer to the underlying content filter.