cFilter

Base Filter Class. More...

Inheritance diagram for cFilter:

Public Types
using	tInitStage = streaming::ant::cFilterBase::tInitStage
Public Types inherited from cConfigurableFilter
typedef base::ant::configuration	base_type_conf
	used base type
typedef streaming::ant::cFilterBase	base_type_filter

Public Member Functions
tResult	RegisterRunner (const char *strName, adtf::base::ant::IRunnable &oRunnable) override
tResult	ConfigureDataInTrigger (const char *strRunnerName, const char *strPinName)
	Creates an internal trigger pipe for the given pin. More...
tResult	ConfigureDataOutTrigger (const char *strRunnerName, const char *strPinName)
	Creates an internal trigger pipe for the given pin. More...
tResult	ConfigureTimerTrigger (const char *strRunnerName, tTimeStamp tmPeriod)
	Creates an internal a internal trigger configuration for a timing trigger. More...
tResult	ConfigureThreadTrigger (const char *strRunnerName, bool bCallCyclic)
	Creates an internal a internal thread configuration for a timing trigger. More...
Public Member Functions inherited from cConfigurableFilter
tResult	GetProperties (ucom::ant::iobject_ptr< const base::ant::IProperties > &pProperties) const override
	Gets the properties with read access. More...
tResult	GetProperties (ucom::ant::iobject_ptr< base::ant::IProperties > &pProperties) override
	Gets the properties with read access. More...
tResult	AttachConfiguration (const char *strName, base::ant::IConfiguration &oAttachedConfiguration) override
	Attaches the given configuration and its properties as property tree item of this. More...
tResult	DetachConfiguration (const char *strName) override
	Detaches a configuration with the specified name. More...
Public Member Functions inherited from object< streaming::ant::cFilterBase, base::ant::configuration<> >
tResult	GetInterface (const char *i_strIID, void *&o_pInterface) override
	Query interfaces on an object. More...
tResult	GetInterface (const char *i_strIID, const void *&o_pInterface) const override
	Provides const correct interface querying. More...
void	Destroy () const override
	Destruct and deallocate instantiations of type IObject. More...
Public Member Functions inherited from IObject
	ADTF_IID (IObject, "object.ant.ucom.adtf.iid")
	Marks the IObject to be castable with the ucom_cast() More...

Protected Member Functions
	cFilter ()
	CTOR.
virtual	~cFilter ()=default
	DTOR.
Protected Member Functions inherited from cConfigurableFilter
	cConfigurableFilter ()=default
	CTOR.
virtual	~cConfigurableFilter ()=default
	DTOR.
Protected Member Functions inherited from IObject
	~IObject ()=default
	Protected destructor --> Use implemented Destroy() instead of delete!

Private Member Functions
	A_UTILS_D (cFilter)
	dpointer impl

Detailed Description

Base Filter Class.

This has been superseded by flash::cFilter.

The cFilter enriches the cConfigurableFilter with functionality to:

• use of cTriggerFunction
• use of Default Trigger Information on the registered runners (adtf::streaming::ant::IRunner).

Use this implementation as your basic implementation for own Filters. Only this Filter is able to create Default Trigger Information that the ADTF Configuration Editor is able to automatic add the required Thread Runner and Timer Runner.

Internal trigger pipes for data triggers are created automatically!

• Data In Triggers can be reconfigured only by adding a non-synchronously connection to the related in pin.
• Data Out Triggers can be reconfigured only by adding a non-synchronously connection from the related out pin.

Remarks

It is recommended to use Legacy Trigger Function.

Definition at line 109 of file filtersdk/include/adtffiltersdk/filter.h.

Member Function Documentation

ConfigureDataInTrigger()

tResult ConfigureDataInTrigger	(	const char *	strRunnerName,
		const char *	strPinName
	)

Creates an internal trigger pipe for the given pin.

It will also create a internal trigger configuration.

Parameters

strRunnerName	[in] The Runner to be triggered if data where received on strPinName.
strPinName	[in] The pin to be triggered from.

Return values

ERR_NOERROR	Succeeded.
ERR_NOTFOUND	Either strPinName or strRunnerName is not registered.

ConfigureDataOutTrigger()

tResult ConfigureDataOutTrigger	(	const char *	strRunnerName,
		const char *	strPinName
	)

Creates an internal trigger pipe for the given pin.

It will also create a internal trigger configuration.

Parameters

strRunnerName	[in] The Runner to be triggered if data where received on strPinName.
strPinName	[in] The pin to trigger forward the tigger to after strRunnerName was triggered.

Return values

ERR_NOERROR	Succeeded.
ERR_NOTFOUND	Either strPinName or strRunnerName is not registered.

ConfigureThreadTrigger()

tResult ConfigureThreadTrigger	(	const char *	strRunnerName,
		bool	bCallCyclic
	)

Creates an internal a internal thread configuration for a timing trigger.

Parameters

strRunnerName	[in] The Runner to be triggered if data where received on strPinName.
bCallCyclic	[in] tFalase - Single Shot Trigger/ true - Endless repeat trigger after returning

Return values

ERR_NOERROR	Succeeded.
ERR_NOTFOUND	Either strPinName or strRunnerName is not registered.

Remarks

Threads are a non deterministic way to work asynchronously. But you can not repeat and simulate executions of thread calls while playback, if you do not use any timing constaints within your implementation.

ConfigureTimerTrigger()

tResult ConfigureTimerTrigger	(	const char *	strRunnerName,
		tTimeStamp	tmPeriod
	)

Creates an internal a internal trigger configuration for a timing trigger.

Parameters

strRunnerName	[in] The Runner to be triggered if data where received on strPinName.
tmPeriod	[in] Default timing period configuration requested.

Return values

ERR_NOERROR	Succeeded.
ERR_NOTFOUND	Either strPinName or strRunnerName is not registered.