rti::routing::transf::TransformationPlugin Class Reference

The top-level plug-in class. More...

#include <TransformationPlugin.hpp>

Public Member Functions
virtual Transformation *	create_transformation (const rti::routing::TypeInfo &input_type_info, const rti::routing::TypeInfo &output_type_info, const rti::routing::PropertySet &properties)=0
	Creates an Output Transformation.
virtual void	delete_transformation (Transformation *transformation)=0
	Deletes a Transformation.
virtual rti::config::LibraryVersion	get_version () const
virtual	~TransformationPlugin ()
	Virtual destructor.

Detailed Description

The top-level plug-in class.

Represents a factory of Transformation.

Constructor & Destructor Documentation

virtual rti::routing::transf::TransformationPlugin::~TransformationPlugin ( )

inlinevirtual

Virtual destructor.

Member Function Documentation

virtual Transformation* rti::routing::transf::TransformationPlugin::create_transformation ( const rti::routing::TypeInfo &  input_type_info, const rti::routing::TypeInfo &  output_type_info, const rti::routing::PropertySet &  properties  )

pure virtual

Creates an Output Transformation.

This function is called when the Output containing the transformation is enabled.

The format associated with the input and output types depends on the format provided by the input and output adapters.

For the built-in DDS adapter, the format of the types is DDS_TypeCode. Required: yes

Parameters

input_type_info	<<in>> Type information associated with the input samples.
output_type_info	<<in>> Type information associated with the output samples.
properties	<<in>> Configuration properties for the Transformation. These properties corresponds to the properties specified within the tag <transformation>.

Returns

New Transformation if successful. Cannot return nullptr.

Exceptions

std::exception

Multi-threading safety:

Safe

virtual void rti::routing::transf::TransformationPlugin::delete_transformation ( Transformation *  transformation )

pure virtual

Deletes a Transformation.

This function is called when the Output containing the transformation is disabled.

Parameters

transformation

<<in>> Transformation to be deleted.

Exceptions

std::exception

Multi-threading safety:

Safe

virtual rti::config::LibraryVersion rti::routing::transf::TransformationPlugin::get_version ( ) const

inlinevirtual

Returns

The version of this TransformationPlugin.

Version is used for logging purposes and allows you to track which version of the TransformationPlugin RTI Routing Service is using.

Default implementation of this operation returns the version of the required Connext libraries.