Namespace for the ADTF Filter SDK. More...

Namespaces
namespace	ant
	Namespace for all functionality of the ADTF Filter SDK provided since v3.0.

namespace	devil
	Namespace for all functionality of the ADTF Filter SDK provided since v3.3.

namespace	flash
	Namespace for all functionality of the ADTF Filter SDK provided since v3.5.

namespace	hollow
	Namespace for all functionality of the ADTF Filter SDK provided since v3.7.

namespace	riddler
	Namespace for all functionality of the ADTF Filter SDK provided since v3.17.

namespace	testing
	Namespace for all testing functionality of the ADTF Filter SDK.

Classes
class	cFilter
	Base class for ADTF filters. More...

class	cRunnerFallback
	This class is used to provide a fallback kernel thread/timer for a runner of a streaming service. More...

class	cSampleStreamingSink
	Base class for ADTF sample streaming sinks. More...

class	cSampleStreamingSource
	Base class for ADTF sample streaming sources. More...

class	cStreamTypeHelper
	Helper class that wraps different objects into an adtf::streaming::ant::IStreamType. More...

class	cSubstreamHandling
	Utility class to handle substream routing within a filter. More...

class	cSubStreamTypes
	Helper class to create a stream type with multiple Substreams. More...

class	cTriggerFunction

class	cTriggerFunctionBase
	Concept class: Basic Trigger functionality. More...

class	data_triggered_filter

class	interface_client
	Helper class that wraps a IBindingClient. More...

class	ITriggerConfiguration
	Internal interface to retrieve the default information a IRunner wants to be configured. More...

class	substream_filter
	Helper class to implement a filter with a single input pin that processes substreams. More...

class	thread_triggered_filter

class	time_triggered_filter

class	triggered_filter
	Simple Filter for Registering One Triggerfunction to a filter. More...

Typedefs
using	cDynamicFilter

using	cPinReader
	use cSampleReader as cPinReader

using	cPinWriter
	use cSampleWriter as cPinWriter

template<typename DATA_TYPE>
using	pin_writer
	Specialized Sample Writer to write DATA of type `DATA_TYPE`.

template<size_t MAX_SIZE, bool STORELASTSAMPLE = true>
using	size_limited_pin_reader
	The size_limited_sample_reader will create a sample reader which will create a internal sample queue that is sample count item limited by the given `TimeRange`.

template<tTimeStamp TIME_RANGE, bool STORELASTSAMPLE = true>
using	time_limited_pin_reader
	The time_limited_sample_reader will create a sample reader which will create a internal sample queue that is time limited by the given `TimeRange`.

template<typename TriggerFunctionImpl, typename FilterClass = cFilterWithTriggerFunction>
using	filter_with_trigger_function

using	cSubstreamFilter
	Helper typedef to use substream_filter with the default filter base class.

Functions
template<typename READERWRITERTYPE, typename PINTYPE>
tResult	filter_create_pin_with_exact_name (cFilter &oFilter, READERWRITERTYPE &oReaderWriter, ucom::ant::iobject_ptr< PINTYPE > &pPinType)
	Creates a Pin for the given reader which has to have the same name as the `oReader`.

template<typename DATA_BINDING_IMPL_TYPE>
tResult	filter_create_pin (DATA_BINDING_IMPL_TYPE &oFilter, adtf::streaming::flash::ISampleReader &oReader)

std::function< tResult(cFilterWithTriggerFunction &)>	pin_trigger (std::vector< util::cString > oTriggerPins)

std::function< tResult(cFilterWithTriggerFunction &)>	thread_trigger (bool bCyclic)

std::function< tResult(cFilterWithTriggerFunction &)>	timer_trigger (tTimeStamp tmDefaultInterval)

Detailed Description

Namespace for the ADTF Filter SDK.

Within this namespace all interfaces, classes and functions always refer to their last revised implementation. When using types defined within this namespace it is guaranteed to always use the latest version of the types.

Typedef Documentation

◆ cDynamicFilter

using cDynamicFilter

Definition at line 71 of file dynamic_filter.h.

◆ cPinReader

using cPinReader

use cSampleReader as cPinReader

Definition at line 49 of file graph_object.h.

◆ cPinWriter

using cPinWriter

use cSampleWriter as cPinWriter

Definition at line 42 of file graph_object.h.

◆ cSubstreamFilter

using cSubstreamFilter

Helper typedef to use substream_filter with the default filter base class.

Example usage

#include <adtffiltersdk/adtf_filtersdk.h>
 
class cMyFilter: public adtf::filter::substream_filter<adtf::filter::cFilter>
{
    public:
        ADTF_CLASS_ID_NAME(cMyFilter, "my_filter.filter.example.cid", "My Filter");
        
        cMyFilter()
        {
            AddSubstreamHandler("your.substream.name", [](const adtf::ucom::iobject_ptr<const adtf::streaming::ISample>& pSample)
            {
                LOG_INFO("received a sample on substream 'your.substream.name'");
            });
        }
};

Definition at line 205 of file substream_handling.h.

◆ filter_with_trigger_function

template<typename TriggerFunctionImpl, typename FilterClass = cFilterWithTriggerFunction>

using filter_with_trigger_function

Definition at line 276 of file triggered_filter.h.

◆ pin_writer

template<typename DATA_TYPE>

using pin_writer

Specialized Sample Writer to write DATA of type DATA_TYPE.

The operator<< will be overloaded to write data.

Definition at line 46 of file graph_object.h.

◆ size_limited_pin_reader

template<size_t MAX_SIZE, bool STORELASTSAMPLE = true>

using size_limited_pin_reader

The size_limited_sample_reader will create a sample reader which will create a internal sample queue that is sample count item limited by the given TimeRange.

Template Parameters

MAX_SIZE	The count in amount of samples (has to be set while compile time!).
STORELASTSAMPLE	Option if the last sample received will be hold. true - last sample is stored false - last sample is droped if after Read call

Definition at line 57 of file graph_object.h.

◆ time_limited_pin_reader

template<tTimeStamp TIME_RANGE, bool STORELASTSAMPLE = true>

using time_limited_pin_reader

The time_limited_sample_reader will create a sample reader which will create a internal sample queue that is time limited by the given TimeRange.

Template Parameters

TIME_RANGE	The timerange in micro seconds (has to be set while compile time!).
STORELASTSAMPLE	Option if the last sample received will be hold. true - last sample is stored false - last sample is droped if after Read call

Definition at line 53 of file graph_object.h.

Function Documentation

◆ filter_create_pin()

template<typename DATA_BINDING_IMPL_TYPE>

tResult filter_create_pin	(	DATA_BINDING_IMPL_TYPE &	oFilter,
		adtf::streaming::flash::ISampleReader &	oReader )

inline

Definition at line 404 of file filter.h.

◆ filter_create_pin_with_exact_name()

template<typename READERWRITERTYPE, typename PINTYPE>

tResult filter_create_pin_with_exact_name	(	cFilter &	oFilter,
		READERWRITERTYPE &	oReaderWriter,
		ucom::ant::iobject_ptr< PINTYPE > &	pPinType )

Creates a Pin for the given reader which has to have the same name as the oReader.

Parameters

[in]	oFilter	filter where to create the pin (IInPin or adtf::streaming::ant::IOutPin).
[in]	oReaderWriter	Reader or writer to create the pin for.
[in,out]	pPinType	returned reference to the pin created

Returns: Standard Result Code

Definition at line 178 of file filter.h.

◆ pin_trigger()

std::function< tResult(cFilterWithTriggerFunction &)> pin_trigger ( std::vector< util::cString > oTriggerPins )

inline

Definition at line 95 of file data_triggered_filter.h.

◆ thread_trigger()

std::function< tResult(cFilterWithTriggerFunction &)> thread_trigger ( bool bCyclic )

inline

Definition at line 89 of file thread_triggered_filter.h.

◆ timer_trigger()

std::function< tResult(cFilterWithTriggerFunction &)> timer_trigger ( tTimeStamp tmDefaultInterval )

inline

Definition at line 86 of file time_triggered_filter.h.

Namespaces

Classes

Typedefs

Functions

Detailed Description

Typedef Documentation

◆ cDynamicFilter

◆ cPinReader

◆ cPinWriter

◆ cSubstreamFilter

Example usage

◆ filter_with_trigger_function

◆ pin_writer

◆ size_limited_pin_reader

◆ time_limited_pin_reader

Function Documentation

◆ filter_create_pin()

◆ filter_create_pin_with_exact_name()

◆ pin_trigger()

◆ thread_trigger()

◆ timer_trigger()