adtf::filter::ant::cFilter Class Reference

#include <filter.h>

Inherits adtf::filter::ant::cConfigurableFilter.

Inherited by adtf::filter::ant::triggered_filter< TriggerFunctionImpl >.

Public Types
using	tInitStage = streaming::ant::cFilterBase::tInitStage
	dpointer impl
Public Types inherited from adtf::filter::ant::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)
tResult	ConfigureDataOutTrigger (const char *strRunnerName, const char *strPinName)
tResult	ConfigureTimerTrigger (const char *strRunnerName, tTimeStamp tmPeriod)
tResult	ConfigureThreadTrigger (const char *strRunnerName, bool bCallCyclic)
Public Member Functions inherited from adtf::filter::ant::cConfigurableFilter
tResult	GetProperties (ucom::ant::iobject_ptr< const base::ant::IProperties > &pProperties) const override
tResult	GetProperties (ucom::ant::iobject_ptr< base::ant::IProperties > &pProperties) override
tResult	AttachConfiguration (const char *strName, base::ant::IConfiguration &oAttachedConfiguration) override
tResult	DetachConfiguration (const char *strName) override
Public Member Functions inherited from adtf::ucom::catwo::object< streaming::ant::cFilterBase, base::ant::configuration<> >
tResult	GetInterface (const char *i_strIID, void *&o_pInterface) override
	Query interfaces on an object.
tResult	GetInterface (const char *i_strIID, const void *&o_pInterface) const override
	Provides const correct interface querying.
void	Destroy () const override
	Switch from non-virtual destructor to virtual destructor.
tResult	GetInterface (const char *i_strIID, void *&o_pInterface) override
	Query interfaces on an object.
tResult	GetInterface (const char *i_strIID, const void *&o_pInterface) const override
	Provides const correct interface querying.
void	Destroy () const override
	Switch from non-virtual destructor to virtual destructor.
tResult	GetInterface (const char *i_strIID, void *&o_pInterface) override
	Query interfaces on an object.
tResult	GetInterface (const char *i_strIID, const void *&o_pInterface) const override
	Provides const correct interface querying.
void	Destroy () const override
	Switch from non-virtual destructor to virtual destructor.
Public Member Functions inherited from adtf::ucom::ant::IObject
	ADTF_IID (IObject, "object.ant.ucom.adtf.iid")

Protected Member Functions
	cFilter ()
virtual	~cFilter () override
	DTOR.
Protected Member Functions inherited from adtf::filter::ant::cConfigurableFilter
	cConfigurableFilter ()=default
	CTOR.
virtual	~cConfigurableFilter ()=default
	DTOR.
Protected Member Functions inherited from adtf::ucom::ant::IObject
	~IObject ()=default
	Protected destructor --> Only the final implementation can be destroyed!

Detailed Description

Base Filter Class.

This has been superseded by flash::cFilter.

The cFilter enriches the cConfigurableFilter with functionality to:

Use this implementation as your basic implementation for own Filters. Only this Filter is able to create trigger information that the ADTF Configuration Editor is able to automatic add the required thread runner and time 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 trigger function.

Constructor & Destructor Documentation

cFilter()

adtf::filter::ant::cFilter::cFilter ( )

protected

CTOR

Deprecated

Triggerfunctions have been superseded by using the API of flash::cFilter.

Member Function Documentation

ConfigureDataInTrigger()

tResult adtf::filter::ant::cFilter::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 adtf::filter::ant::cFilter::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 forward the trigger after strRunnerName was triggered.

Return values

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

ConfigureThreadTrigger()

tResult adtf::filter::ant::cFilter::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 adtf::filter::ant::cFilter::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.

---

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

• src/libraries/filtersdk/include/adtffiltersdk/filter.h