time_triggered_filter.h

Go to the documentation of this file.

#pragma once
#include "triggered_filter.h"
 
#include <adtf_base_deprecated.h>
 
namespace adtf
{
namespace filter
{
namespace ant
{

template<typename TriggerFunctionImpl, tTimeStamp DEFAULT_PERIOD >
class time_triggered_filter : public triggered_filter < TriggerFunctionImpl >
{
 
protected:
    typedef triggered_filter < TriggerFunctionImpl > base_type;
 
public:
    ADTF3_DEPRECATED("Class 'time_triggered_filter' is deprecated, as well as macro 'ADTF_TIME_TRIGGERED_FILTER'."
                     "Use class 'filter_with_trigger_function' or macros 'ADTF_TRIGGER_FUNCTION_FILTER' / 'ADTF_TRIGGER_FUNCTION_FILTER_PLUGIN' instead.")
    time_triggered_filter() : base_type()
    {
    }
    
    ~time_triggered_filter()
    {
    }
 
protected:
    tResult CreateDefaultTrigger(const char* strFunctionName) override
    {
        using namespace adtf::base;
        tTimeStamp tmCurrentPeriod = DEFAULT_PERIOD;
        RETURN_IF_FAILED(base_type::ConfigureTimerTrigger(strFunctionName, tmCurrentPeriod));
        RETURN_NOERROR;
    }
};
 
} //namespace ant
 
namespace detail
{
 
template<typename FilterClass>
tResult timer_trigger(FilterClass& oFilter, tTimeStamp tmDefaultInterval)
{
    return oFilter.ConfigureTimerTrigger(oFilter.GetTriggerFunctionName(),
                                         tmDefaultInterval);
}
 
}
 
namespace devil
{
 
inline std::function<tResult(cFilterWithTriggerFunction&)> timer_trigger(tTimeStamp tmDefaultInterval)
{
    return std::bind(detail::timer_trigger<cFilterWithTriggerFunction>, std::placeholders::_1, tmDefaultInterval);
}
 
} //namespace devil
 
namespace hollow
{
 
inline std::function<tResult(cFilterWithTriggerFunction&)> timer_trigger(tTimeStamp tmDefaultInterval)
{
    return std::bind(detail::timer_trigger<cFilterWithTriggerFunction>, std::placeholders::_1, tmDefaultInterval);
}
 
} //namespace devil
 
using ant::time_triggered_filter;
using hollow::timer_trigger;

#define ADTF_TIME_TRIGGERED_FILTER_NAME(_class_identifier_,\
                                        _class_name_,\
                                        _timetriggerfilterclass_,\
                                        _triggerfunction_,\
                                        _time_period_micro_sec_,\
                                        ...) \
    ADTF_TRIGGER_FUNCTION_FILTER(_class_identifier_,\
                               _class_name_,\
                               _timetriggerfilterclass_,\
                               _triggerfunction_,\
                               adtf::filter::timer_trigger(_time_period_micro_sec_),\
                               __VA_ARGS__)

#define ADTF_TIME_TRIGGERED_FILTER(_class_identifier_,\
                                   _timetriggerfilterclass_,\
                                   _triggerfunction_,\
                                   _time_period_micro_sec_) \
    ADTF_TIME_TRIGGERED_FILTER_NAME(_class_identifier_,\
                                    _class_identifier_,\
                                    _timetriggerfilterclass_,\
                                    _triggerfunction_,\
                                    _time_period_micro_sec_)
 
} //namespace filter
} //namespace adtf