ADTF: adtf::filter::ant Namespace Reference

Namespace for all functionality of the ADTF Filter SDK provided since v3.0. More...

Classes
class	cDynamicFilter
	Dynamic Base Filter Class. More...

class	cConfigurableFilter
	Enriches the adtf::streaming::ant::cFilterBase class with the configuration. More...

class	cFilter
	Base Filter Class. More...

class	data_triggered_filter

class	thread_triggered_filter

class	time_triggered_filter

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

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

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

class	cTriggerFunction

Typedefs
using	cPinWriter = adtf::streaming::ant::cSampleWriter
	use cSampleWriter as cPinWriter

template<typename DATA_TYPE >
using	pin_writer = adtf::streaming::ant::sample_writer< DATA_TYPE >
	Specialized Sample Writer to write DATA of type `DATA_TYPE`. More...

using	cPinReader = adtf::streaming::ant::cDynamicSampleReader
	use cSampleReader as cPinReader

template<tTimeStamp TIME_RANGE, bool STORELASTSAMPLE = true>
using	time_limited_pin_reader = adtf::streaming::ant::time_limited_sample_reader< TIME_RANGE, STORELASTSAMPLE >
	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`. More...

template<size_t MAX_SIZE, bool STORELASTSAMPLE = true>
using	size_limited_pin_reader = adtf::streaming::ant::size_limited_sample_reader< MAX_SIZE, STORELASTSAMPLE >
	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`. More...

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`. More...

template<typename READERWRITERTYPE >
tResult	filter_create_pin_with_exact_name (cFilter &oFilter, READERWRITERTYPE &oReaderWriter)
	Creates a Pin for the given reader which has to have the same name as the `oReader`. More...

template<typename READERWRITERTYPE , typename PINTYPE >
tResult	filter_create_pin (cFilter &oFilter, READERWRITERTYPE &oReaderORWriter, ucom::ant::iobject_ptr< PINTYPE > &pPin)

tResult	filter_create_pin (cFilter &oFilter, adtf::streaming::ant::cSampleReader &oReader)

tResult	filter_create_pin (cFilter &oFilter, adtf::streaming::ant::cSampleWriter &oWriter)

tResult	filter_create_pin (cFilter &oFilter, adtf::streaming::ant::cSampleReader &oReaderORWriter, const char *strName, const ucom::ant::iobject_ptr< const adtf::streaming::ant::IStreamType > &pType)

tResult	filter_create_pin (cFilter &oFilter, adtf::streaming::ant::cSampleWriter &oReaderORWriter, const char *strName, const ucom::ant::iobject_ptr< const streaming::ant::IStreamType > &pType)

Detailed Description

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

Typedef Documentation

◆ pin_writer

using pin_writer = adtf::streaming::ant::sample_writer<DATA_TYPE>

Specialized Sample Writer to write DATA of type DATA_TYPE.

The operator<< will be overloaded to write data.

Definition at line 77 of file filtersdk/include/adtffiltersdk/filter.h.

◆ size_limited_pin_reader

using size_limited_pin_reader = adtf::streaming::ant::size_limited_sample_reader<MAX_SIZE, STORELASTSAMPLE>

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 88 of file filtersdk/include/adtffiltersdk/filter.h.

◆ time_limited_pin_reader

using time_limited_pin_reader = adtf::streaming::ant::time_limited_sample_reader<TIME_RANGE, STORELASTSAMPLE>

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 84 of file filtersdk/include/adtffiltersdk/filter.h.

Function Documentation

◆ filter_create_pin_with_exact_name() [1/2]

tResult adtf::filter::ant::filter_create_pin_with_exact_name	(	cFilter &	oFilter,
		READERWRITERTYPE &	oReaderWriter
	)

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

Parameters

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

Returns: Standard Result Code

Definition at line 194 of file filtersdk/include/adtffiltersdk/filter.h.

References adtf_string_intf.

◆ filter_create_pin_with_exact_name() [2/2]

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