time_triggered_filter.h File Reference

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

Include dependency graph for time_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::time_triggered_filter< TriggerFunctionImpl, DEFAULT_PERIOD >
class	adtf::filter::time_triggered_filter< TriggerFunctionImpl, DEFAULT_PERIOD >

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_TIME_TRIGGERED_FILTER_NAME(_class_identifier_, _class_name_, _timetriggerfilterclass_, _triggerfunction_, _time_period_micro_sec_, ...)
#define	ADTF_TIME_TRIGGERED_FILTER(_class_identifier_, _timetriggerfilterclass_, _triggerfunction_, _time_period_micro_sec_)

Functions
template<typename FilterClass>
tResult	adtf::filter::detail::timer_trigger (FilterClass &oFilter, tTimeStamp tmDefaultInterval)
std::function< tResult(cFilterWithTriggerFunction &)>	adtf::filter::devil::timer_trigger (tTimeStamp tmDefaultInterval)
std::function< tResult(cFilterWithTriggerFunction &)>	adtf::filter::hollow::timer_trigger (tTimeStamp tmDefaultInterval)
std::function< tResult(cFilterWithTriggerFunction &)>	adtf::filter::timer_trigger (tTimeStamp tmDefaultInterval)

Detailed Description

Copyright © Audi Electronics Venture GmbH. All rights reserved

Macro Definition Documentation

ADTF_TIME_TRIGGERED_FILTER

#define ADTF_TIME_TRIGGERED_FILTER	(		_class_identifier_,
			_timetriggerfilterclass_,
			_triggerfunction_,
			_time_period_micro_sec_ )

Value:

    ADTF_TIME_TRIGGERED_FILTER_NAME(_class_identifier_,\
                                    _class_identifier_,\
                                    _timetriggerfilterclass_,\
                                    _triggerfunction_,\
                                    _time_period_micro_sec_)

Deprecated

Use macros ADTF_TRIGGER_FUNCTION_FILTER / ADTF_TRIGGER_FUNCTION_FILTER_PLUGIN instead.

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

Parameters

[in]	_class_identifier_	class identifier to set a id for the class factory: i.e. "example.mydatafilter.adtf"
[in]	_timetriggerfilterclass_	class/decltype of the filter to create
[in]	_time_period_micro_sec_	default property for the time runner
[in]	_triggerfunction_	class/decpltype for the trigger function.

ADTF_TIME_TRIGGERED_FILTER_NAME

#define ADTF_TIME_TRIGGERED_FILTER_NAME	(		_class_identifier_,
			_class_name_,
			_timetriggerfilterclass_,
			_triggerfunction_,
			_time_period_micro_sec_,
			... )

Value:

    ADTF_TRIGGER_FUNCTION_FILTER(_class_identifier_,\
                               _class_name_,\
                               _timetriggerfilterclass_,\
                               _triggerfunction_,\
                               adtf::filter::timer_trigger(_time_period_micro_sec_),\
                               __VA_ARGS__)

Deprecated

Use macros ADTF_TRIGGER_FUNCTION_FILTER / ADTF_TRIGGER_FUNCTION_FILTER_PLUGIN instead.

Macro to generate a filter body for a time triggered filter. This macro uses the adtf::filter::ant::time_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]	_timetriggerfilterclass_	class/decltype of the filter to create
[in]	_triggerfunction_	class/decpltype for the trigger function.
[in]	_time_period_micro_sec_	default property for the time runner