data_triggered_filter.h File Reference

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

Include dependency graph for data_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::data_triggered_filter< TriggerFunctionImpl, InPinListOfTriggers >
class	adtf::filter::data_triggered_filter< TriggerFunctionImpl, InPinListOfTriggers >

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_DATA_TRIGGERED_PIN_LIST(_triggerlistclass_, _listcommaseparated_)
#define	ADTF_DATA_TRIGGERED_FILTER_NAME(_class_identifier_, _class_name_, _datatriggerfilterclass_, _triggerfunction_, _triggerlistclass_, ...)
#define	ADTF_DATA_TRIGGERED_FILTER(_class_identifier_, _datatriggerfilterclass_, _triggerfunction_, _triggerlistclass_)

Functions
template<typename FilterClass>
tResult	adtf::filter::detail::pin_trigger (FilterClass &oFilter, const std::vector< util::cString > &oTriggerPins)
std::function< tResult(cFilterWithTriggerFunction &)>	adtf::filter::devil::pin_trigger (std::vector< util::cString > oTriggerPins)
std::function< tResult(cFilterWithTriggerFunction &)>	adtf::filter::hollow::pin_trigger (std::vector< util::cString > oTriggerPins)
std::function< tResult(cFilterWithTriggerFunction &)>	adtf::filter::pin_trigger (std::vector< util::cString > oTriggerPins)

Detailed Description

Copyright © Audi Electronics Venture GmbH. All rights reserved

Macro Definition Documentation

ADTF_DATA_TRIGGERED_FILTER

#define ADTF_DATA_TRIGGERED_FILTER	(		_class_identifier_,
			_datatriggerfilterclass_,
			_triggerfunction_,
			_triggerlistclass_ )

Value:

    ADTF_DATA_TRIGGERED_FILTER_NAME(_class_identifier_, \
                                    _class_identifier_, \
                                    _datatriggerfilterclass_, \
                                    _triggerfunction_, \
                                    _triggerlistclass_)

Deprecated

Use macros ADTF_TRIGGER_FUNCTION_FILTER / ADTF_TRIGGER_FUNCTION_FILTER_PLUGIN instead.

Helper macro to define a Data Trigered Filter.

This macro will create a simple filter implementation. You only need to implement a trigger function.

Parameters

[in]	_class_identifier_	class identifier to det a id for the class factory: i.e. "example.mydatafilter.adtf"
[in]	_datatriggerfilterclass_	class/decltype of the filter to create
[in]	_triggerlistclass_	name of the list pin trigger list (as decltype !). See ADTF_DATA_TRIGGERED_PIN_LIST
[in]	_triggerfunction_	class/decpltype for the trigger function.

ADTF_DATA_TRIGGERED_FILTER_NAME

#define ADTF_DATA_TRIGGERED_FILTER_NAME	(		_class_identifier_,
			_class_name_,
			_datatriggerfilterclass_,
			_triggerfunction_,
			_triggerlistclass_,
			... )

Value:

class _datatriggerfilterclass_ : public adtf::filter::data_triggered_filter<_triggerfunction_,  _triggerlistclass_> \
{ \
    public:\
        ADTF_CLASS_ID_NAME(_datatriggerfilterclass_, _class_identifier_, _class_name_); \
        __VA_ARGS__;\
    public: \
    _datatriggerfilterclass_() = default; \
    virtual ~_datatriggerfilterclass_() = default; \
}

Deprecated

Use macros ADTF_TRIGGER_FUNCTION_FILTER / ADTF_TRIGGER_FUNCTION_FILTER_PLUGIN instead.

Helper macro to define a Data Trigered Filter.

This macro will create a simple filter implementation. You only need to implement a trigger function.

Parameters

[in]	_class_identifier_	class identifier to det 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]	_datatriggerfilterclass_	class/decltype of the filter to create
[in]	_triggerlistclass_	name of the list pin trigger list (as decltype !). See ADTF_DATA_TRIGGERED_PIN_LIST
[in]	_triggerfunction_	class/decpltype for the trigger function.

ADTF_DATA_TRIGGERED_PIN_LIST

#define ADTF_DATA_TRIGGERED_PIN_LIST	(		_triggerlistclass_,
			_listcommaseparated_ )

Value:

struct _triggerlistclass_ \
{ \
    static adtf_util::cStringList GetPinTriggerList() \
    { \
         return adtf_util::cStringList(_listcommaseparated_); \
    } \
}

Defintion of a Helper List to create a Pin Trigger list for the adtf::filter::ant::data_triggered_filter.

See also

Example Demo Data Trigger

Parameters

[in]	_triggerlistclass_	name of the list (as decltype !)
[in]	_listcommaseparated_	comma separated string litaral with the pin names to trigger