PJ::TransformFunction Class Reference

Generic interface for a multi input - multi output transformation function. Contrariwise to other plugins, multiple instances of the this class might be created. For this reason, a TransformFactory is also defined. More...

#include <transform_function.h>

Inheritance diagram for PJ::TransformFunction:

Public Types
using	Ptr = std::shared_ptr< TransformFunction >

Signals
void	parametersChanged ()

Public Member Functions
virtual void	calculate ()=0
std::vector< const PlotData * > &	dataSources ()
virtual const char *	name () const =0
	Name of the plugin type, NOT the particular instance. More...
virtual int	numInputs () const =0
virtual int	numOutputs () const =0
unsigned	order () const
PlotDataMapRef *	plotData ()
virtual void	reset ()
virtual void	setData (PlotDataMapRef *data, const std::vector< const PlotData * > &src_vect, std::vector< PlotData * > &dst_vect)
	TransformFunction ()
virtual	~TransformFunction ()=default
Public Member Functions inherited from PJ::PlotJugglerPlugin
virtual const std::vector< QAction * > &	availableActions ()
virtual bool	isDebugPlugin ()
virtual QWidget *	optionsWidget ()
	optionsWidget pointer to a persistent widget used to set the plugin options . More...
	PlotJugglerPlugin ()=default
virtual bool	xmlLoadState (const QDomElement &parent_element)
	Override this method to load the status of the plugin from XML. More...
QDomElement	xmlSaveState (QDomDocument &doc) const
virtual bool	xmlSaveState (QDomDocument &doc, QDomElement &parent_element) const
	Override this method to save the status of the plugin to XML. More...

Protected Attributes
PlotDataMapRef *	_data
std::vector< PlotData * >	_dst_vector
unsigned	_order
std::vector< const PlotData * >	_src_vector

Detailed Description

Generic interface for a multi input - multi output transformation function. Contrariwise to other plugins, multiple instances of the this class might be created. For this reason, a TransformFactory is also defined.

Definition at line 22 of file transform_function.h.

Member Typedef Documentation

Ptr

using PJ::TransformFunction::Ptr = std::shared_ptr<TransformFunction>

Definition at line 27 of file transform_function.h.

Constructor & Destructor Documentation

TransformFunction()

PJ::TransformFunction::TransformFunction

(

)

Definition at line 11 of file transform_function.cpp.

~TransformFunction()

virtual PJ::TransformFunction::~TransformFunction ( )

virtualdefault

Member Function Documentation

calculate()

virtual void PJ::TransformFunction::calculate ( )

pure virtual

Implemented in PJ::TransformFunction_SISO, PJ::ReactiveLuaFunction, CustomFunction, and QuaternionToRollPitchYaw.

dataSources()

std::vector< const PlotData * > & PJ::TransformFunction::dataSources

(

)

Definition at line 17 of file transform_function.cpp.

name()

virtual const char* PJ::TransformFunction::name ( ) const

pure virtual

Name of the plugin type, NOT the particular instance.

Implements PJ::PlotJugglerPlugin.

Implemented in PJ::ReactiveLuaFunction, MovingAverageFilter, MovingVarianceFilter, MovingRMS, OutlierRemovalFilter, ScaleTransform, SamplesCountFilter, LuaCustomFunction, FirstDerivative, IntegralTransform, AbsoluteTransform, and QuaternionToRollPitchYaw.

numInputs()

virtual int PJ::TransformFunction::numInputs ( ) const

pure virtual

Number of inputs. Return -1 if it is not a constant.

When numInputs() > 0, then the data will be initialized using the method: setDataSource(const std::vector<const PlotData*>& src_data)

When numInputs() == -1, then the number of inputs is undefined and the data will be initialized using the method_ setDataSource( PlotDataMapRef* data )

Implemented in PJ::TransformFunction_SISO, PJ::ReactiveLuaFunction, CustomFunction, and QuaternionToRollPitchYaw.

numOutputs()

virtual int PJ::TransformFunction::numOutputs ( ) const

pure virtual

Number of outputs. Define the size of the vector used in: calculate(std::vector<PlotData*>& dst_data)

Implemented in PJ::TransformFunction_SISO, PJ::ReactiveLuaFunction, CustomFunction, and QuaternionToRollPitchYaw.

order()

unsigned PJ::TransformFunction::order ( ) const

inline

Definition at line 69 of file transform_function.h.

parametersChanged

void PJ::TransformFunction::parametersChanged ( )

signal

plotData()

PlotDataMapRef* PJ::TransformFunction::plotData ( )

inline

Definition at line 57 of file transform_function.h.

reset()

virtual void PJ::TransformFunction::reset ( )

inlinevirtual

Clear the cache, state and any stored data

Reimplemented in PJ::TransformFunction_SISO, PJ::ReactiveLuaFunction, CustomFunction, IntegralTransform, MovingAverageFilter, MovingVarianceFilter, MovingRMS, and QuaternionToRollPitchYaw.

Definition at line 53 of file transform_function.h.

setData()

void PJ::TransformFunction::setData ( PlotDataMapRef *  data, const std::vector< const PlotData * > &  src_vect, std::vector< PlotData * > &  dst_vect  )

virtual

Definition at line 22 of file transform_function.cpp.

Member Data Documentation

_data

PlotDataMapRef* PJ::TransformFunction::_data

protected

Definition at line 80 of file transform_function.h.

_dst_vector

std::vector<PlotData*> PJ::TransformFunction::_dst_vector

protected

Definition at line 79 of file transform_function.h.

_order

unsigned PJ::TransformFunction::_order

protected

Definition at line 82 of file transform_function.h.

_src_vector

std::vector<const PlotData*> PJ::TransformFunction::_src_vector

protected

Definition at line 78 of file transform_function.h.

---

The documentation for this class was generated from the following files:

• transform_function.h
• transform_function.cpp