triggered_filter.h File Reference

#include <adtffiltersdk/filter.h>
#include <memory>
#include <functional>

Include dependency graph for 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::triggered_filter< TriggerFunctionImpl >
class	adtf::filter::devil::cFilterWithTriggerFunction
class	adtf::filter::devil::filter_with_trigger_function< TriggerFunctionImpl >
class	adtf::filter::flash::filter_with_trigger_function< TriggerFunctionImpl, FilterClass >
class	adtf::filter::hollow::cFilterWithTriggerFunction
class	adtf::filter::triggered_filter< TriggerFunctionImpl >

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::flash
	Namespace for all functionality of the ADTF Filter SDK provided since v3.5.
namespace	adtf::filter::hollow
	Namespace for all functionality of the ADTF Filter SDK provided since v3.7.

Macros
#define	ADTF_TRIGGER_FUNCTION_FILTER(_class_identifier_, _class_name_, _triggerfilterclass_, _triggerfunction_, _trigger_configurator_, ...)
#define	ADTF_TRIGGER_FUNCTION_FILTER_PLUGIN(_class_identifier_, _class_name_, _triggerfunction_, _trigger_configurator_, ...)

Typedefs
template<typename TriggerFunctionImpl, typename FilterClass = cFilterWithTriggerFunction>
using	adtf::filter::hollow::filter_with_trigger_function = flash::filter_with_trigger_function<TriggerFunctionImpl, cFilterWithTriggerFunction>
template<typename TriggerFunctionImpl, typename FilterClass = cFilterWithTriggerFunction>
using	adtf::filter::filter_with_trigger_function

Detailed Description

Copyright © Audi Electronics Venture GmbH. All rights reserved

Macro Definition Documentation

ADTF_TRIGGER_FUNCTION_FILTER

#define ADTF_TRIGGER_FUNCTION_FILTER	(		_class_identifier_,
			_class_name_,
			_triggerfilterclass_,
			_triggerfunction_,
			_trigger_configurator_,
			... )

Value:

class _triggerfilterclass_ : public adtf::filter::filter_with_trigger_function<_triggerfunction_> \
{ \
    public:\
        ADTF_CLASS_ID_NAME(_triggerfilterclass_, _class_identifier_, _class_name_); \
        __VA_ARGS__;\
    public: \
        _triggerfilterclass_():\
          filter_type(_trigger_configurator_)\
        {\
        }\
}

Macro to generate a filter body for a filter with a trigger function. This macro uses the adtf::filter::devil::filter_with_trigger_function 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]	_triggerfilterclass_	class/decltype of the filter to create
[in]	_triggerfunction_	class/decpltype for the trigger function.
[in]	_trigger_configurator_	the trigger configuration function.
[in]	...	additional class member definitions, see ADTF_CLASS_DEPENDENCIES.

ADTF_TRIGGER_FUNCTION_FILTER_PLUGIN

#define ADTF_TRIGGER_FUNCTION_FILTER_PLUGIN	(		_class_identifier_,
			_class_name_,
			_triggerfunction_,
			_trigger_configurator_,
			... )

Value:

    ADTF_TRIGGER_FUNCTION_FILTER(_class_identifier_,\
                                 _class_name_,\
                                 _triggerfunction_##Filter,\
                                 _triggerfunction_,\
                                 _trigger_configurator_,\
                                 __VA_ARGS__);\
    ADTF_PLUGIN(_class_name_ " Plugin",\
                _triggerfunction_##Filter)

This macro defines a filter with a given trigger function and exposes it via a plugin class factory.

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]	_triggerfunction_	class/decpltype for the trigger function.
[in]	_trigger_configurator_	the trigger configuration function.