thread_triggered_filter< TriggerFunctionImpl, CYCLIC_THREAD >

Inheritance diagram for thread_triggered_filter< TriggerFunctionImpl, CYCLIC_THREAD >:

Public Member Functions
	ADTF3_DEPRECATED ("Class 'thread_triggered_filter' is deprecated, as well as macro 'ADTF_THREAD_TRIGGERED_FILTER'." "Use class 'filter_with_trigger_function' or macros 'ADTF_TRIGGER_FUNCTION_FILTER' / 'ADTF_TRIGGER_FUNCTION_FILTER_PLUGIN' instead.") thread_triggered_filter()
	CTOR.
	~thread_triggered_filter ()
	DTOR.
Public Member Functions inherited from cFilter
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 Types
typedef triggered_filter< TriggerFunctionImpl >	base_type
	base type of thread_triggered_filter

Protected Member Functions
tResult	CreateDefaultTrigger (const char *strFunctionName) override
Protected Member Functions inherited from triggered_filter< TriggerFunctionImpl >
tResult	Init (tInitStage eStage) override
tResult	SetParent (const adtf::ucom::ant::IObject *poParentObject) override
Protected Member Functions inherited from cFilter
	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!

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

Detailed Description

template<typename TriggerFunctionImpl, bool CYCLIC_THREAD = true>
class adtf::filter::ant::thread_triggered_filter< TriggerFunctionImpl, CYCLIC_THREAD >

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 Thread Runner to create as Active Runner.

Template Parameters

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

Definition at line 30 of file thread_triggered_filter.h.