thread_triggered_filter.h File Reference

#include "triggered_filter.h"
#include <adtf_base_deprecated.h>

Include dependency graph for thread_triggered_filter.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
class	adtf::filter::ant::thread_triggered_filter< TriggerFunctionImpl, CYCLIC_THREAD >
class	adtf::filter::thread_triggered_filter< TriggerFunctionImpl, CYCLIC_THREAD >

Namespaces
namespace	adtf
	Namespace for all functionality provided by ADTF and its SDKs.
namespace	adtf::filter
	Namespace for the ADTF Filter SDK.
namespace	adtf::filter::ant
	Namespace for all functionality of the ADTF Filter SDK provided since v3.0.
namespace	adtf::filter::devil
	Namespace for all functionality of the ADTF Filter SDK provided since v3.3.
namespace	adtf::filter::hollow
	Namespace for all functionality of the ADTF Filter SDK provided since v3.7.

Macros
#define	ADTF_THREAD_TRIGGERED_FILTER_NAME(_class_identifier_, _class_name_, _threadtriggerfilterclass_, _triggerfunction_, _thread_cyclic_, ...)
#define	ADTF_THREAD_TRIGGERED_FILTER(_class_identifier_, _threadtriggerfilterclass_, _triggerfunction_, _thread_cyclic_)

Functions
template<typename FilterClass>
tResult	adtf::filter::detail::thread_trigger (FilterClass &oFilter, bool bCyclic)
std::function< tResult(cFilterWithTriggerFunction &)>	adtf::filter::devil::thread_trigger (bool bCyclic)
std::function< tResult(cFilterWithTriggerFunction &)>	adtf::filter::hollow::thread_trigger (bool bCyclic)
std::function< tResult(cFilterWithTriggerFunction &)>	adtf::filter::thread_trigger (bool bCyclic)

Detailed Description

Copyright © Audi Electronics Venture GmbH. All rights reserved

Macro Definition Documentation

ADTF_THREAD_TRIGGERED_FILTER

#define ADTF_THREAD_TRIGGERED_FILTER	(		_class_identifier_,
			_threadtriggerfilterclass_,
			_triggerfunction_,
			_thread_cyclic_ )

Value:

    ADTF_THREAD_TRIGGERED_FILTER_NAME(_class_identifier_,\
                                      _class_identifier_,\
                                      _threadtriggerfilterclass_,\
                                      _triggerfunction_,\
                                      _thread_cyclic_)

Deprecated

Use macros ADTF_TRIGGER_FUNCTION_FILTER / ADTF_TRIGGER_FUNCTION_FILTER_PLUGIN instead.

Macro to generate a filter body for a thread triggered filter. This macro uses the adtf::filter::ant::thread_triggered_filter template.

Parameters

[in]	_class_identifier_	class identifier to set a id for the class factory: i.e. "example.mydatafilter.adtf"
[in]	_threadtriggerfilterclass_	class/decltype of the filter to create
[in]	_thread_cyclic_	default property for the thread runner: either cyclic or not. (cyclic recommended, use non cyclic only if this single shot call returns.)
[in]	_triggerfunction_	class/decpltype for the trigger function.

ADTF_THREAD_TRIGGERED_FILTER_NAME

#define ADTF_THREAD_TRIGGERED_FILTER_NAME	(		_class_identifier_,
			_class_name_,
			_threadtriggerfilterclass_,
			_triggerfunction_,
			_thread_cyclic_,
			... )

Value:

    ADTF_TRIGGERED_FILTER_NAME(_class_identifier_,\
                               _class_name_,\
                               _threadtriggerfilterclass_,\
                               _triggerfunction_,\
                               adtf::filter::thread_trigger(_thread_cyclic_))

Deprecated

Use macros ADTF_TRIGGER_FUNCTION_FILTER / ADTF_TRIGGER_FUNCTION_FILTER_PLUGIN instead.

Macro to generate a filter body for a thread triggered filter. This macro uses the adtf::filter::ant::thread_triggered_filter template.

Parameters

[in]	_class_identifier_	class identifier to set a id for the class factory: i.e. "example.mydatafilter.adtf"
[in]	_class_name_	class name i.e. to describe the filter "My Data Filter Example"
[in]	_threadtriggerfilterclass_	class/decltype of the filter to create
[in]	_thread_cyclic_	default property for the thread runner: either cyclic or not. (cyclic recommended, use non cyclic only if this single shot call returns.)
[in]	_triggerfunction_	class/decpltype for the trigger function.