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

Classes
class	cConfigurableFilter

class	cFilter

class	cTriggerFunction

class	cTriggerFunctionBase

class	data_triggered_filter

class	ITriggerConfiguration

class	thread_triggered_filter

class	time_triggered_filter

class	triggered_filter

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>

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>

template<size_t MAX_SIZE, bool STORELASTSAMPLE = true>
using	size_limited_pin_reader = adtf::streaming::ant::size_limited_sample_reader<MAX_SIZE, STORELASTSAMPLE>

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

template<typename READERWRITERTYPE>
tResult	filter_create_pin_with_exact_name (cFilter &oFilter, READERWRITERTYPE &oReaderWriter)

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

template<typename DATA_TYPE>

using adtf::filter::ant::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.

◆ size_limited_pin_reader

template<size_t MAX_SIZE, bool STORELASTSAMPLE = true>

using adtf::filter::ant::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

◆ time_limited_pin_reader

template<tTimeStamp TIME_RANGE, bool STORELASTSAMPLE = true>

using adtf::filter::ant::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

Function Documentation

◆ filter_create_pin_with_exact_name() [1/2]

template<typename READERWRITERTYPE>

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

◆ filter_create_pin_with_exact_name() [2/2]

template<typename READERWRITERTYPE, typename PINTYPE>

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