#include <time_triggered_filter.h>

Inherits adtf::filter::ant::triggered_filter< TriggerFunctionImpl >.

Public Member Functions
	ADTF3_DEPRECATED ("Class 'time_triggered_filter' is deprecated, as well as macro 'ADTF_TIME_TRIGGERED_FILTER'." "Use class 'filter_with_trigger_function' or macros 'ADTF_TRIGGER_FUNCTION_FILTER' / 'ADTF_TRIGGER_FUNCTION_FILTER_PLUGIN' instead.") time_triggered_filter()

	~time_triggered_filter ()
	DTOR.

Public Member Functions inherited from adtf::filter::ant::cFilter
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 Types
typedef triggered_filter< TriggerFunctionImpl >	base_type

Protected Member Functions
tResult	CreateDefaultTrigger (const char *strFunctionName) override

Protected Member Functions inherited from adtf::filter::ant::triggered_filter< TriggerFunctionImpl >
tResult	Init (tInitStage eStage) override

tResult	SetParent (const adtf::ucom::ant::IObject *poParentObject) override

Protected Member Functions inherited from adtf::filter::ant::cFilter
	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!

Additional Inherited Members
Public Types inherited from adtf::filter::ant::cFilter
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

Detailed Description

template<typename TriggerFunctionImpl, tTimeStamp DEFAULT_PERIOD>
class adtf::filter::time_triggered_filter< TriggerFunctionImpl, DEFAULT_PERIOD >

Deprecated: Use class adtf::filter::devil::filter_with_trigger_function instead.

Generate a filter body for a filter which create one runner that calls the Trigger Function given in parameter TriggerFunctionImpl. The default description wants a Timer Runner to create as Active Runner.

Template Parameters

TriggerFunctionImpl	decltype of the Trigger Function implementation.
DEFAULT_PERIOD	true or false to create the default Thread Runner behaviour.

Member Function Documentation

◆ ADTF3_DEPRECATED()

template<typename TriggerFunctionImpl, tTimeStamp DEFAULT_PERIOD>

adtf::filter::ant::time_triggered_filter< TriggerFunctionImpl, DEFAULT_PERIOD >::ADTF3_DEPRECATED	(	"Class 'time_triggered_filter< TriggerFunctionImpl, DEFAULT_PERIOD >' is	deprecated,
		as well as macro 'ADTF_TIME_TRIGGERED_FILTER'." "Use class 'filter_with_trigger_function' or macros 'ADTF_TRIGGER_FUNCTION_FILTER'/ 'ADTF_TRIGGER_FUNCTION_FILTER_PLUGIN' instead."	)

inline

CTR

Deprecated: Class 'time_triggered_filter' is deprecated, as well as macro 'ADTF_TIME_TRIGGERED_FILTER'. Use class 'filter_with_trigger_function' or macros 'ADTF_TRIGGER_FUNCTION_FILTER' / 'ADTF_TRIGGER_FUNCTION_FILTER_PLUGIN' instead.

◆ CreateDefaultTrigger()

template<typename TriggerFunctionImpl, tTimeStamp DEFAULT_PERIOD>

tResult adtf::filter::ant::time_triggered_filter< TriggerFunctionImpl, DEFAULT_PERIOD >::CreateDefaultTrigger ( const char * strFunctionName )

inlineoverrideprotectedvirtual

Reimplemented from adtf::filter::ant::triggered_filter< TriggerFunctionImpl >.

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

src/libraries/filtersdk/include/adtffiltersdk/standardfilter/time_triggered_filter.h

Public Member Functions

Protected Types

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ ADTF3_DEPRECATED()

◆ CreateDefaultTrigger()