adtf::streaming::ant Namespace Reference

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

Namespaces
namespace	detail
	Namespace for all internally used functionality implemented.
namespace	imageformat_definition
	Namespace to sort pixelformat descriptions.

Classes
class	binding_proxy
class	binding_type
class	cBindingClient
class	cBindingProxyOutPort
class	cBindingServer
class	cBindingType
class	cConfigurableInPin
class	cConfigurableOutPin
class	cDataBinding
class	cDefaultBindingProxy
class	cDynamicSampleReaderQueue
	Implementation of a adtf::streaming::ant::ISampleReaderQueue with dynamic growing sample queue. More...
class	cExternalQueueSampleReader
	Sample reader which allows the registration of external queue. More...
class	cExternelQueueSampleReader
	Sample reader which allows the registration of external queue. More...
class	cFilterBase
	The cFilterBase class implements a basic filter that supports the ant::IFilter interfaces. More...
class	cFilterGraphClientPort
class	cFilterGraphDataInPort
class	cFilterGraphDataOutPort
class	cFilterGraphRunnerPort
class	cFilterGraphServerPort
class	cFilterLevelmachine
class	cGraph
class	cInPin
class	cInterfaceBinding
class	cLastSampleReader
	Sample reader which always provides the last successful received sample. More...
class	cLastSamplesCollector
class	cLimitedSampleReaderQueue
class	cOutPin
class	cReferenceSample
class	cRuntimeBehaviour
class	cSample
class	cSampleLogEntry
class	cSampleLogEntryList
class	cSampleLogEntryTransmitReceiveStateBuffer
class	cSampleQueue
struct	cSampleQueueCompareByTime
class	cSampleReader
	The default Sample Reader will read the incomung Stream of a IInPin. This sample reader has no internal queue! Make sure if you use this sample reader with ISampleStreamAccess::PushRead to register a external queue or to override the adtf::streaming::ant::cSampleReader::ReadNextSample and adtf::streaming::ant::cSampleReader::Push methods. More...
class	cSampleSetCollector
class	cSampleStream
class	cSampleStreamingSink
class	cSampleStreamingSource
class	cSampleStreamInPort
class	cSampleStreamOutPort
class	cSampleWriter
class	cStreamingGraph
class	cStreamItem
class	cStreamMetaType
class	cStreamType
class	cTimeBasedSampleSetCollector
class	data_binding
class	graph
class	graph_connection
class	IActiveRunner
class	IBindingClient
class	IBindingObject
class	IBindingProxy
class	IBindingProxyInPort
class	IBindingProxyOutPort
class	IBindingServer
class	IBindingType
class	IDataBinding
class	IDynamicDataBinding
class	IDynamicInterfaceBinding
class	IFilter
class	IFilterGraph
class	IFilterGraphConnection
class	IFilterGraphDataInPort
class	IFilterGraphDataOutPort
class	IFilterGraphDataPort
class	IFilterGraphInterfaceClientPort
class	IFilterGraphInterfacePort
class	IFilterGraphInterfaceServerPort
class	IFilterGraphPort
class	IFilterGraphRunnerPort
class	IGraph
class	IGraphConnection
class	IInPin
class	IInterfaceBinding
class	INamedGraphObject
class	interface_binding
class	IOutPin
class	IPin
class	IRunner
class	IRuntimeBehaviour
class	ISample
class	ISampleBuffer
class	ISampleBufferFactory
class	ISampleInfo
class	ISampleInStream
class	ISampleLog
class	ISampleOutStream
class	ISampleQueue
class	ISampleQueueEventSink
class	ISampleReader
class	ISampleReaderQueue
	Interface to create a sample reader buffer. More...
class	ISampleSerialization
class	ISampleStream
class	ISampleStreamAccess
class	ISampleStreamer
	Local Sample Streamer Interface. This interface is only used to create a cInPin and cOutPin in a generic way. concrete implementations are cSampleReder and cSampleWriter. Use the sample_streamer template to implement own Writers and Readers. More...
class	ISampleStreamingSink
class	ISampleStreamingSource
class	ISampleStreamInPort
class	ISampleStreamOutPort
class	ISampleWriter
class	IStreamingGraph
class	IStreamingInPort
class	IStreamingOutPort
class	IStreamingPort
class	IStreamingService
class	IStreamingSink
class	IStreamingSource
class	IStreamItem
class	IStreamMetaType
	Defines access methods for a Stream Meta Type. More...
class	IStreamType
	Defines access methods for the interface of a Stream Type. More...
class	ITriggerPipe
class	ITriggerPipeItem
class	ITriggerPipeSource
class	named_graph_object
class	runtime_behaviour
class	sample_data
class	sample_reader
	A Possible Sample Reader of a Trigger Function! Sample reader with a internal queue, used for ISampleStreamAccess::PushRead! Make sure the trigger function empties the queue!! More...
class	sample_stream
class	sample_streamer
class	sample_writer
class	size_limited_sample_reader_queue
class	stream_meta_type
struct	stream_meta_type_anonymous
	Use this Stream Meta Type only if no property should be set and you do not share and record these data. Anonymous can be any kind of data. More...
struct	stream_meta_type_audio
	Use this Stream Meta Type for describing a audio stream with samples and sample rate. More...
struct	stream_meta_type_image
	Use this Stream Meta Type for describing a video stream with single frames and there format and set the values with set_stream_type_image_format. More...
struct	stream_meta_type_plain
	Use this Stream Meta Type if your sample data will be any of this type: bool, uint8_t, int8_t, uint16_t, int16_t, uint32_t, int32_t, uint64_t, int64_t, float or double. More...
class	stream_type_plain
	Generator template to create an instance of a ant::IStreamType class for ant::stream_meta_type_plain ("adtf/plaintype"). More...
class	streaming_level_machine
class	time_limited_sample_reader_queue
struct	tStreamImageFormat

Typedefs
using	cDynamicSampleReader = sample_reader<cDynamicSampleReaderQueue>
	The cDynamicSampleReader will create a sample reader which will create a internal sample queue with unlimited size.
template<tTimeStamp TIME_RANGE, bool STORELASTSAMPLE = true>
using	time_limited_sample_reader = sample_reader<time_limited_sample_reader_queue<TIME_RANGE>, STORELASTSAMPLE>
template<size_t MAX_SIZE, bool STORELASTSAMPLE = true>
using	size_limited_sample_reader = sample_reader<size_limited_sample_reader_queue<MAX_SIZE>, STORELASTSAMPLE>
using	cSingleSampleReader = size_limited_sample_reader<1>
	The cSingleSampleReader will create a sample reader which will create a internal sample queue with only one sample which holds the last received sample always.
typedef adtf_util::stack_string_base< ADTF_STREAMING_DEFAULT_SIZE_OF_STREAM_IMAGE_FORMATNAME, adtf_util::assert_out_of_range >	cStreamFormatStorageType
	formatname storage type (max byte size defined by ADTF_STREAMING_DEFAULT_SIZE_OF_STREAM_IMAGE_FORMATNAME)
typedef adtf_util::string_base< cStreamFormatStorageType >	tStreamImageFormatName
	formatname type as stack string (max byte size defined by ADTF_STREAMING_DEFAULT_SIZE_OF_STREAM_IMAGE_FORMATNAME)

Functions
template<typename DATABINDING_BEHAVIOUR_CLASS>
tResult	create_inner_pipe (DATABINDING_BEHAVIOUR_CLASS &oComponent, adtf_util::cStringList lstItems)
template<typename DATABINDING_BEHAVIOUR_CLASS, typename RUN_FUNC>
tResult	create_inner_pipe (DATABINDING_BEHAVIOUR_CLASS &oComponent, const adtf_util::cString &strNameOfRunner, const adtf_util::cString &strSource, RUN_FUNC &&oRunFunc)
template<typename INTERFACE>
tResult	create_server (cFilterBase &oFilter, const char *strServerName, const adtf::ucom::iobject_ptr< INTERFACE > &pServerInterface)
template<typename INTERFACE>
tResult	create_client (cFilterBase &oFilter, const char *strClientName)
tResult	create_runner (cFilterBase &oFilter, const char *strNameOfRunner, adtf::base::ant::IRunnable &oRunnable)
tResult	get_named_graph_object_from_graph (IGraph &oGraph, const char *strName, ucom::ant::iobject_ptr< ucom::ant::IObject > &pObjectFound)
adtf_util::cString	get_named_graph_object_full_name (const INamedGraphObject &oGraphObject)
adtf_util::cString	get_named_graph_object_full_name (const INamedGraphObject &oGraphObject, const char *strSeperator)
template<typename DATA_BINDING_IMPL_TYPE>
tResult	create_pin (DATA_BINDING_IMPL_TYPE &oDataBindingImpl, cSampleWriter &oWriter, const char *strNameOfWriterAndPin, const ucom::iobject_ptr< const IStreamType > &pStreamType, ucom::iobject_ptr< IOutPin > &pPinCreated)
template<typename DATA_BINDING_IMPL_TYPE>
tResult	create_pin (DATA_BINDING_IMPL_TYPE &oDataBindingImpl, cSampleWriter &oWriter, const char *strNameOfWriterAndPin, const adtf::ucom::iobject_ptr< const IStreamType > &pStreamType)
template<typename DATA_BINDING_IMPL_TYPE>
tResult	create_pin (DATA_BINDING_IMPL_TYPE &oDataBindingImpl, cSampleWriter &oWriter, const char *strNameOfWriterAndPin, const adtf::ucom::iobject_ptr< IStreamType > &pStreamType)
template<typename DATA_BINDING_IMPL_TYPE>
tResult	create_pin (DATA_BINDING_IMPL_TYPE &oDataBindingImpl, cSampleReader &oReader, const char *strNameOfReaderAndPin, const ucom::iobject_ptr< const IStreamType > &pStreamType, ucom::iobject_ptr< IInPin > &pPinCreated)
template<typename DATA_BINDING_IMPL_TYPE>
tResult	create_pin (DATA_BINDING_IMPL_TYPE &oDataBindingImpl, cSampleReader &oReader, const char *strNameOfReaderAndPin, const ucom::iobject_ptr< const IStreamType > &pStreamType)
template<typename DATA_BINDING_IMPL_TYPE>
tResult	create_pin (DATA_BINDING_IMPL_TYPE &oDataBindingImpl, cSampleReader &oReader, const char *strNameOfReaderAndPin, const adtf::ucom::iobject_ptr< IStreamType > &pStreamType)
tResult	alloc_sample (ucom::ant::iobject_ptr< ucom::ant::IObject > &pSampleObject, const char *strSampleCID)
tResult	alloc_sample (ucom::ant::iobject_ptr< ucom::ant::IObject > &pSample, const char *strSampleCID, tTimeStamp nTimeStamp)
tResult	alloc_sample (ucom::ant::iobject_ptr< ISample > &pSample)
tResult	alloc_sample (ucom::ant::iobject_ptr< ISample > &pSample, tTimeStamp nTimeStamp)
template<typename T>
tResult	read_from_sample (const ISample &oSample, T &oValue)
template<typename T>
tResult	write_to_sample (ISample &oSample, const T &oValue)
tResult	get_default_buffer_factory (adtf::ucom::iobject_ptr< ISampleBufferFactory > &pFactory)
tResult	get_reference_buffer_factory (adtf::ucom::iobject_ptr< ISampleBufferFactory > &pFactory)
adtf::util::cVariant	get_sample_info (const ISampleInfo &oSampleInfo, const ISampleInfo::tHashKey &oHash, const adtf::util::cVariant oDefault)
adtf::util::cVariant	get_sample_info (const ISampleInfo &oSampleInfo, const ISampleInfo::tHashKey &oHash)
adtf::util::cVariant	get_sample_info (const ISample &oSample, const ISampleInfo::tHashKey &oHash, const adtf::util::cVariant oDefault)
adtf::util::cVariant	get_sample_info (const ISample &oSample, const ISampleInfo::tHashKey &oHash)
tResult	set_sample_info (ISampleInfo &oSampleInfo, const ISampleInfo::tHashKey &oHash, const adtf::util::cVariant oValue)
tResult	set_sample_info (ISample &oSample, const ISampleInfo::tHashKey &oHash, const adtf::util::cVariant oValue)
ISampleInfo::tHashKey	create_sample_info_hash_key (const char *strToHash)
const ISampleInStream &	operator>> (const ISampleInStream &oStreamReader, IStreamItem &oItem)
ISampleOutStream &	operator<< (ISampleOutStream &oStreamWriter, const adtf::ucom::ant::iobject_ptr< const ISample > &pSample)
ISampleOutStream &	operator<< (ISampleOutStream &oStreamWriter, const adtf::ucom::ant::iobject_ptr< const IStreamType > &pStreamType)
ISampleOutStream &	operator<< (ISampleOutStream &oStreamWriter, const adtf::ucom::ant::iobject_ptr< IStreamType > &pStreamType)
ISampleOutStream &	operator<< (ISampleOutStream &oStreamWriter, ISampleOutStream &(*pStreamfunc)(ISampleOutStream &))
ISampleOutStream &	operator<< (ISampleOutStream &oStreamWriter, const tResult &oErr)
cSampleReader &	operator>> (cSampleReader &oSampleReader, ucom::ant::iobject_ptr< const ISample > &pSample)
template<typename DATATYPE>
cSampleReader &	operator>> (cSampleReader &oSampleReader, sample_data< DATATYPE > &oSampleData)
cSampleReader &	operator>> (cSampleReader &oSampleReader, ucom::ant::iobject_ptr< const IStreamType > &pType)
cSampleReader &	operator>> (cSampleReader &oSampleReader, cSampleReader &(*pStreamfunc)(cSampleReader &))
tResult	make_sample_reader (cSampleReader &oReader, const char *strNameOfReader, const ucom::iobject_ptr< const IStreamType > &pStreamType)
cSampleWriter &	operator<< (cSampleWriter &oSampleWriter, const ucom::ant::iobject_ptr< const ISample > &pSample)
cSampleWriter &	operator<< (cSampleWriter &oSampleWriter, const ucom::ant::iobject_ptr< ISample > &pSample)
cSampleWriter &	operator<< (cSampleWriter &oSampleWriter, const ucom::ant::iobject_ptr< const IStreamType > &pType)
cSampleWriter &	operator<< (cSampleWriter &oSampleWriter, cSampleWriter &(*pStreamfunc)(cSampleWriter &))
cSampleWriter &	operator<< (cSampleWriter &oSampleWriter, const tResult &oError)
template<typename DATA_TYPE>
sample_writer< DATA_TYPE > &	operator<< (sample_writer< DATA_TYPE > &oSampleWriter, const DATA_TYPE &oSampleData)
cSampleReader &	operator>> (cSampleReader &oSampleReader, cSampleWriter &oSampleWriter)
tResult	make_sample_writer (cSampleWriter &oWriter, const char *strNameOfWriter, const ucom::ant::iobject_ptr< const IStreamType > &pStreamType)
bool	operator!= (const tStreamImageFormat &sLeft, const tStreamImageFormat &sRight)
bool	operator== (const tStreamImageFormat &sLeft, const tStreamImageFormat &sRight)
	ADTF_DEFINE_STREAM_IMAGE_FORMAT (RGB_8, "R(3)G(3)B(2)") ADTF_DEFINE_STREAM_IMAGE_FORMAT(RGB_555
	Format definition.
	R (5) G(5) B(5)(1)") ADTF_DEFINE_STREAM_IMAGE_FORMAT(RGB_565
	Format definition.
	R (8) G(8) B(8)") ADTF_DEFINE_STREAM_IMAGE_FORMAT(BGR_24
	Format definition.
	B (8) G(8) R(8)") ADTF_DEFINE_STREAM_IMAGE_FORMAT(RGB_32
	A (8) B(8) G(8) R(8)") ADTF_DEFINE_STREAM_IMAGE_FORMAT(ARGB_32
	A (8) R(8) G(8) B(8)") bool stream_image_format_is_generic_greyscale( const tStreamImageFormat & strFormat)
	Format definition.
bool	stream_image_format_is_generic_rgb (const tStreamImageFormat &strFormat)
bool	stream_image_format_is_generic (const tStreamImageFormat &strFormat)
unsigned int	stream_image_format_get_generic_pixel_size (const tStreamImageFormat &strFormat)
uint32_t	stream_image_format_get_generic_mask (const char *strChannel, const tStreamImageFormat &strFormat)
template<typename WRITER_TYPE>
WRITER_TYPE &	flush (WRITER_TYPE &oWriter)
template<typename WRITER_TYPE>
WRITER_TYPE &	trigger (WRITER_TYPE &oWriter)
tResult	get_streaming_graph_object (const IStreamingGraph &oGraph, ucom::ant::iobject_ptr< ucom::ant::IObject > &pObject)
tResult	get_streaming_graph_objects (const IStreamingGraph &oGraph, ucom::ant::iobject_enum< ucom::ant::IObject > &lstObjects)
tResult	set_stream_type_image_format (IStreamType &oType, const tStreamImageFormat &oFormat)
tResult	get_stream_type_image_format (tStreamImageFormat &oFormat, const IStreamType &oType)
	ADTF_DEFINE_STREAM_TYPE_PLAIN_FOR (tBool, "BOOL")
	ADTF_DEFINE_STREAM_TYPE_PLAIN_FOR (tInt8, "INT8")
	ADTF_DEFINE_STREAM_TYPE_PLAIN_FOR (tUInt8, "UINT8")
	ADTF_DEFINE_STREAM_TYPE_PLAIN_FOR (tInt16, "INT16")
	ADTF_DEFINE_STREAM_TYPE_PLAIN_FOR (tUInt16, "UINT16")
	ADTF_DEFINE_STREAM_TYPE_PLAIN_FOR (tInt32, "INT32")
	ADTF_DEFINE_STREAM_TYPE_PLAIN_FOR (tUInt32, "UINT32")
	ADTF_DEFINE_STREAM_TYPE_PLAIN_FOR (tInt64, "INT64")
	ADTF_DEFINE_STREAM_TYPE_PLAIN_FOR (tUInt64, "UINT64")
	ADTF_DEFINE_STREAM_TYPE_PLAIN_FOR (tFloat32, "FLOAT32")
	ADTF_DEFINE_STREAM_TYPE_PLAIN_FOR (tFloat64, "FLOAT64")
template<typename T>
bool	operator== (const IStreamType &oStreamType, T)
	The equality operator returns true only if the given oStreamType is an instance of the stream_meta_type in T. It will compare the unique meta type name.
template<typename T>
bool	operator!= (const IStreamType &oStreamType, T oValue)
	The not-equality operator returns false only if the given oStreamType is not an instance of the stream_meta_type in T. It will compare the unique meta type name.
bool	operator== (const IStreamType &oStreamTypeLeft, const IStreamType &oStreamTypeRight)
	The equality operator returns true only if the given oStreamTypeLeft has the exact same properties and property values as oStreamTypeRight. This works in both ways.
bool	operator!= (const IStreamType &oStreamTypeLeft, const IStreamType &oStreamTypeRight)
	The not-equality operator returns false only if the given oStreamTypeLeft has the exact same properties and property values as oStreamTypeRight. This works in both ways.
template<typename VALUETYPE>
tResult	set_property (IStreamType &oStreamType, const char *strNameOfValue, VALUETYPE oValue)
tResult	set_property (IStreamType &oStreamType, const char *strNameOfValue, const char *poValue)
template<typename VALUETYPE>
VALUETYPE	get_property (const IStreamType &oStreamType, const char *strNameOfValue, VALUETYPE oDefaultValue)
template<typename VALUETYPE>
VALUETYPE	get_property (const IStreamType &oStreamType, const char *strNameOfValue)
template<typename T, typename std::enable_if_t< flash::is_stream_meta_type< T >::value, int > = 0>
bool	operator== (const ucom::ant::iobject_ptr< const IStreamType > &pStreamType, const T &oValue)
	The equality operator returns true only if the given pStreamType is an instance of the stream_meta_type in T. It will compare the unique meta type name.
template<typename T, typename std::enable_if_t< flash::is_stream_meta_type< T >::value, int > = 0>
bool	operator!= (const ucom::ant::iobject_ptr< const IStreamType > &pStreamType, const T &oValue)
	The equality operator returns true only if the given pStreamType is an instance of the stream_meta_type in T. It will compare the unique meta type name.

Detailed Description

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

Typedef Documentation

cDynamicSampleReader

using adtf::streaming::ant::cDynamicSampleReader = sample_reader<cDynamicSampleReaderQueue>

The cDynamicSampleReader will create a sample reader which will create a internal sample queue with unlimited size.

Remarks

Make sure a a sample receive callback will read until the queue is empty !

This implementation uses the cDynamicSampleReaderQueue as dynamic sample queue implementation.

size_limited_sample_reader

template<size_t MAX_SIZE, bool STORELASTSAMPLE = true>

using adtf::streaming::ant::size_limited_sample_reader = sample_reader<size_limited_sample_reader_queue<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_sample_reader

template<tTimeStamp TIME_RANGE, bool STORELASTSAMPLE = true>

using adtf::streaming::ant::time_limited_sample_reader = sample_reader<time_limited_sample_reader_queue<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

A() [1/2]

adtf::streaming::ant::A

(

8

)

Format definition this description means always first in lowest bit of lowest byte

A() [2/2]

adtf::streaming::ant::A

(

8

)

const &

Format definition.

Format definition this description means always first in lowest bit of lowest byte Check if GREY component is available.

Parameters

strFormat

a generic stream image format.

Returns

Returns true when GREY component is available

ADTF_DEFINE_STREAM_IMAGE_FORMAT()

adtf::streaming::ant::ADTF_DEFINE_STREAM_IMAGE_FORMAT	(	RGB_8	,
		"R(3)G(3)B(2)"	)

Format definition.

BYTE ORDER FORMAT DESCRIPTION Format definition Format definition Format definition Format definition Format definition

ADTF_DEFINE_STREAM_TYPE_PLAIN_FOR() [1/11]

adtf::streaming::ant::ADTF_DEFINE_STREAM_TYPE_PLAIN_FOR	(	tBool	,
		"BOOL"	)

defines a stream_type_plain for the c-type bool

ADTF_DEFINE_STREAM_TYPE_PLAIN_FOR() [2/11]

adtf::streaming::ant::ADTF_DEFINE_STREAM_TYPE_PLAIN_FOR	(	tFloat32	,
		"FLOAT32"	)

defines a stream_type_plain for the c-type float

ADTF_DEFINE_STREAM_TYPE_PLAIN_FOR() [3/11]

adtf::streaming::ant::ADTF_DEFINE_STREAM_TYPE_PLAIN_FOR	(	tFloat64	,
		"FLOAT64"	)

defines a stream_type_plain for the c-type double

ADTF_DEFINE_STREAM_TYPE_PLAIN_FOR() [4/11]

adtf::streaming::ant::ADTF_DEFINE_STREAM_TYPE_PLAIN_FOR	(	tInt16	,
		"INT16"	)

defines a stream_type_plain for the c-type int16_t

ADTF_DEFINE_STREAM_TYPE_PLAIN_FOR() [5/11]

adtf::streaming::ant::ADTF_DEFINE_STREAM_TYPE_PLAIN_FOR	(	tInt32	,
		"INT32"	)

defines a stream_type_plain for the c-type int32_t

ADTF_DEFINE_STREAM_TYPE_PLAIN_FOR() [6/11]

adtf::streaming::ant::ADTF_DEFINE_STREAM_TYPE_PLAIN_FOR	(	tInt64	,
		"INT64"	)

defines a stream_type_plain for the c-type int64_t

ADTF_DEFINE_STREAM_TYPE_PLAIN_FOR() [7/11]

adtf::streaming::ant::ADTF_DEFINE_STREAM_TYPE_PLAIN_FOR	(	tInt8	,
		"INT8"	)

defines a stream_type_plain for the c-type int8_t

ADTF_DEFINE_STREAM_TYPE_PLAIN_FOR() [8/11]

adtf::streaming::ant::ADTF_DEFINE_STREAM_TYPE_PLAIN_FOR	(	tUInt16	,
		"UINT16"	)

defines a stream_type_plain for the c-type uint16_t

ADTF_DEFINE_STREAM_TYPE_PLAIN_FOR() [9/11]

adtf::streaming::ant::ADTF_DEFINE_STREAM_TYPE_PLAIN_FOR	(	tUInt32	,
		"UINT32"	)

defines a stream_type_plain for the c-type uint32_t

ADTF_DEFINE_STREAM_TYPE_PLAIN_FOR() [10/11]

adtf::streaming::ant::ADTF_DEFINE_STREAM_TYPE_PLAIN_FOR	(	tUInt64	,
		"UINT64"	)

defines a stream_type_plain for the c-type uint64_t

ADTF_DEFINE_STREAM_TYPE_PLAIN_FOR() [11/11]

adtf::streaming::ant::ADTF_DEFINE_STREAM_TYPE_PLAIN_FOR	(	tUInt8	,
		"UINT8"	)

defines a stream_type_plain for the ctype uint8_t

alloc_sample() [1/4]

tResult adtf::streaming::ant::alloc_sample

(

ucom::ant::iobject_ptr< ISample > &

pSample

)

Helper Function to get a ISample Instance through the adtf::ucom::ant::IRuntime.

Parameters

pSample

[in, out] object_ptr to a ISample if succeeded. The default CID will be the get_class_id<cSample>().

Returns

Standard result code.

Note

rtsafe{if the sample pool and the memory allocator services are avaliable during RL_Running}

alloc_sample() [2/4]

tResult adtf::streaming::ant::alloc_sample	(	ucom::ant::iobject_ptr< ISample > &	pSample,
		tTimeStamp	nTimeStamp )

Helper Function to get a ISample Instance through the adtf::ucom::ant::IRuntime.

Parameters

pSample	[in, out] object_ptr to a ISample if succeeded. The default CID will be the get_class_id<cSample>().
nTimeStamp	[in] The timestamp of the sample.

Returns

Standard result code.

Note

rtsafe{if the sample pool and the memory allocator services are avaliable during RL_Running}

alloc_sample() [3/4]

tResult adtf::streaming::ant::alloc_sample	(	ucom::ant::iobject_ptr< ucom::ant::IObject > &	pSample,
		const char *	strSampleCID,
		tTimeStamp	nTimeStamp )

Helper Function to get a Sample Instance through the adtf::ucom::ant::IRuntime.

Parameters

pSample	[in, out] object_ptr to of Sample if succeeded. Due to the unknown interface you want receive it is provided as object_ptr<IObject>.
strSampleCID	[in] Sample object identifier (class id) of the sample class. If strSampleOID is empty then the get_class_id<cSample>() will be used.
nTimeStamp	[in] The timestamp of the sample.

Returns

Standard result code.

Note

rtsafe{if the sample pool and the memory allocator services are avaliable during RL_Running}

alloc_sample() [4/4]

tResult adtf::streaming::ant::alloc_sample	(	ucom::ant::iobject_ptr< ucom::ant::IObject > &	pSampleObject,
		const char *	strSampleCID )

Helper Function to get a Sample Instance through the adtf::ucom::ant::IRuntime.

Parameters

pSampleObject	[in, out] object_ptr to of Sample if succeeded. Due to the unknown interface you want receive it is provided as object_ptr<IObject>.
strSampleCID	[in] Sample object identifier (class id) of the sample class. If strSampleOID is empty then the get_class_id<cSample>() will be used.

Returns

Standard result code.

Note

rtsafe{if the sample pool and the memory allocator services are avaliable during RL_Running}

B()

adtf::streaming::ant::B

(

8

)

Format definition this description means always first in lowest bit of lowest byte

create_client()

template<typename INTERFACE>

tResult adtf::streaming::ant::create_client	(	cFilterBase &	oFilter,
		const char *	strClientName )

Creates a binding client object for the given INTERFACE type and register it on the cFilterBase instance

Template Parameters

INTERFACE

The IObject interface you want to register the binding client object for

Parameters

[in]	oFilter	filter instance to register the client object to
[in]	strClientName	name of the object to register

Returns

Standard Result Code

create_inner_pipe() [1/2]

template<typename DATABINDING_BEHAVIOUR_CLASS>

tResult adtf::streaming::ant::create_inner_pipe ( DATABINDING_BEHAVIOUR_CLASS & oComponent, adtf_util::cStringList lstItems )

inline

Creates a trigger pipe and registers it at the given oFilter instance.

You can use an initializer list for the lstItems as follow:

create_inner_pipe(m_oMyFilter, {"in_pin_1", "my_fancy_runner", "out_pin_1"};

This function will create a pipe where the "my_fancy_runner" will be called from "in_pin_1" if some a synchronous DataTrigger is received. "my_fanc_runner" will read data from "in_pin_1" by its Readers (or do something else) and writes data to the "out_pin_1". If the "my_fancy_runner" returns it will forward a synchronous DataTrigger to "out_pin_1".

Parameters

[in]	oComponent	databinding and runtime behavior instance where to register the trigger pipe.
[in]	lstItems	list of items of the trigger pipe. These items can be a registered Pin of the oFilter or a Runner of oFilter.

Returns

Standard Result Code of the cFilterBase::RegisterInnerPipe call.

Return values

ERR_NOT_FOUND

A given name is not a Pin (InPin or OutPin) or a Runner registered on oFilter.

create_inner_pipe() [2/2]

template<typename DATABINDING_BEHAVIOUR_CLASS, typename RUN_FUNC>

tResult adtf::streaming::ant::create_inner_pipe	(	DATABINDING_BEHAVIOUR_CLASS &	oComponent,
		const adtf_util::cString &	strNameOfRunner,
		const adtf_util::cString &	strSource,
		RUN_FUNC &&	oRunFunc )

Creates a trigger pipe and registers it at the given oFilter instance.

You can call this function like this:

create_inner_pipe(m_oMyFilter, "my_fancy_runner", "in_pin_1", ADTF_RUN_FUNCTION(Read));

This function will create a pipe where the "my_fancy_runner" will be called from "in_pin_1" if some synchronous DataTrigger is received. "my_fancy_runner" will then trigger the Read functor to handle that event (e.g. read in the data sample).

Parameters

[in]	oComponent	databinding and runtime behavior instance where to register the trigger pipe.
[in]	strNameOfRunner	name of the runner
[in]	strSource	name of the source where the trigger is receive from
[in]	oRunFunc	function to call if trigger is received

Returns

Standard Result Code of the cFilterBase::RegisterInnerPipe call.

Return values

ERR_NOT_FOUND

A given name is not a Pin (InPin or OutPin) or a Runner registered on oFilter.

create_pin() [1/6]

template<typename DATA_BINDING_IMPL_TYPE>

tResult adtf::streaming::ant::create_pin	(	DATA_BINDING_IMPL_TYPE &	oDataBindingImpl,
		cSampleReader &	oReader,
		const char *	strNameOfReaderAndPin,
		const adtf::ucom::iobject_ptr< IStreamType > &	pStreamType )

Creates a cInPin and registers it at the given oDataBindingImpl instance.

Template Parameters

DATA_BINDING_IMPL_TYPE

concrete type of a IDataBinding implementation.

Parameters

[in]	oDataBindingImpl	FileBase instance where to register the InPin.
[in]	oReader	SampleReader which will be registerd at the cInpin as ISampleStreamer
[in]	strNameOfReaderAndPin	The Pin Name to set on the InPin. Also the SampleReaders Name will be changed.
[in]	pStreamType	Type initially set to the Reader. A deep copy is made.

Returns

Standard Result Code of the cFilterBase::RegisterPin call.

create_pin() [2/6]

template<typename DATA_BINDING_IMPL_TYPE>

tResult adtf::streaming::ant::create_pin	(	DATA_BINDING_IMPL_TYPE &	oDataBindingImpl,
		cSampleReader &	oReader,
		const char *	strNameOfReaderAndPin,
		const ucom::iobject_ptr< const IStreamType > &	pStreamType )

Creates a cInPin and registers it at the given oDataBindingImpl instance.

Template Parameters

DATA_BINDING_IMPL_TYPE

concrete type of a IDataBinding implementation

Parameters

[in]	oDataBindingImpl	databinding instance where to register the InPin.
[in]	oReader	SampleReader which will be registerd at the cInpin as ISampleStreamer
[in]	strNameOfReaderAndPin	The Pin Name to set on the InPin. Also the SampleReaders Name will be changed.
[in]	pStreamType	Type initially set to the Reader. A deep copy is made.

Returns

Standard Result Code of the cFilterBase::RegisterPin call.

create_pin() [3/6]

template<typename DATA_BINDING_IMPL_TYPE>

tResult adtf::streaming::ant::create_pin	(	DATA_BINDING_IMPL_TYPE &	oDataBindingImpl,
		cSampleReader &	oReader,
		const char *	strNameOfReaderAndPin,
		const ucom::iobject_ptr< const IStreamType > &	pStreamType,
		ucom::iobject_ptr< IInPin > &	pPinCreated )

Creates a cInPin and registers it at the given oDataBindingImpl instance.

Template Parameters

DATA_BINDING_IMPL_TYPE

concrete type of a IDataBinding implementation

Parameters

[in]	oDataBindingImpl	databinding implementation instance where to register the InPin.
[in]	oReader	SampleReader which will be registerd at the cInpin as ISampleStreamer
[in]	strNameOfReaderAndPin	The Pin Name to set on the InPin. Also the SampleReaders Name will be changed.
[in]	pStreamType	Type initially set to the Reader. A deep copy is made.
[in,out]	pPinCreated	Pin created will be returned

Returns

Standard Result Code of the cFilterBase::RegisterPin call.

create_pin() [4/6]

template<typename DATA_BINDING_IMPL_TYPE>

tResult adtf::streaming::ant::create_pin	(	DATA_BINDING_IMPL_TYPE &	oDataBindingImpl,
		cSampleWriter &	oWriter,
		const char *	strNameOfWriterAndPin,
		const adtf::ucom::iobject_ptr< const IStreamType > &	pStreamType )

Creates a cOutPin and registers it at the given oDataBindingImpl instance.

Template Parameters

DATA_BINDING_IMPL_TYPE

implementation type of a data_binding to register pins to Following adtf default types support this: cFilterBase cSampleStreamSource

Parameters

[in]	oDataBindingImpl	data_binding instance where to register the OutPin.
[in]	oWriter	SampleWriter which will be registered at the cOutpin as ISampleWriter
[in]	strNameOfWriterAndPin	The Pin name to set on the OutPin. Also the SampleWriters name will be changed.
[in]	pStreamType	Type initially set to the writer. A deep copy is made.

Returns

Standard Result Code of the cFilterBase::RegisterPin call.

create_pin() [5/6]

template<typename DATA_BINDING_IMPL_TYPE>

tResult adtf::streaming::ant::create_pin	(	DATA_BINDING_IMPL_TYPE &	oDataBindingImpl,
		cSampleWriter &	oWriter,
		const char *	strNameOfWriterAndPin,
		const adtf::ucom::iobject_ptr< IStreamType > &	pStreamType )

Creates a cOutPin and registers it at the given oDataBindingImpl instance.

Template Parameters

DATA_BINDING_IMPL_TYPE

implementation type of a data_binding to register pins to Following adtf default types support this: cFilterBase cSampleStreamSource

Parameters

[in]	oDataBindingImpl	data_binding instance where to register the OutPin.
[in]	oWriter	SampleWriter which will be registered at the cOutpin as ISampleWriter
[in]	strNameOfWriterAndPin	The Pin name to set on the OutPin. Also the SampleWriters name will be changed.
[in]	pStreamType	Type initially set to the writer. A deep copy is made.

Returns

Standard Result Code of the cDataBinding::RegisterPin call.

create_pin() [6/6]

template<typename DATA_BINDING_IMPL_TYPE>

tResult adtf::streaming::ant::create_pin	(	DATA_BINDING_IMPL_TYPE &	oDataBindingImpl,
		cSampleWriter &	oWriter,
		const char *	strNameOfWriterAndPin,
		const ucom::iobject_ptr< const IStreamType > &	pStreamType,
		ucom::iobject_ptr< IOutPin > &	pPinCreated )

Creates a cOutPin and registers it at the given oDataBindingImpl instance.

Template Parameters

DATA_BINDING_IMPL_TYPE

implementation type of a data_binding to register pins to Following adtf default types support this: cFilterBase cSampleStreamSource

Parameters

[in]	oDataBindingImpl	data_binding instance where to register the OutPin.
[in]	oWriter	SampleWriter which will be registered at the cOutpin as ISampleWriter
[in]	strNameOfWriterAndPin	The Pin name to set on the OutPin. Also the SampleWriters name will be changed.
[in]	pStreamType	Type initially set to the writer. A deep copy is made.
[in,out]	pPinCreated	Pin created will be returned

Returns

Standard Result Code of the cFilterBase::RegisterPin call.

create_runner()

tResult adtf::streaming::ant::create_runner ( cFilterBase & oFilter, const char * strNameOfRunner, adtf::base::ant::IRunnable & oRunnable )

inline

Creates a runner on the given cFilterBase and connect it to the given Runnable You only need to implement a Runnable

See also

adtf::base::runnable

adtf::base::IRunnable

Returns

Standard Result Code

create_sample_info_hash_key()

ISampleInfo::tHashKey adtf::streaming::ant::create_sample_info_hash_key

(

const char *

strToHash

)

Generation of unambigious hash key for a string. This generation is independent to process and platform.

Parameters

[in]

strToHash

null terminated string to generate a hash key for.

Returns

Hash key for strToHash.

create_server()

template<typename INTERFACE>

tResult adtf::streaming::ant::create_server	(	cFilterBase &	oFilter,
		const char *	strServerName,
		const adtf::ucom::iobject_ptr< INTERFACE > &	pServerInterface )

Creates a binding server object for the given INTERFACE type and register it on the cFilterBase instance.

Template Parameters

INTERFACE

The IObject interface you want to register the binding server object for. Used to create a IBindingType.

Parameters

[in]	oFilter	filter instance to register the server object to
[in]	strServerName	name of the object to register
[in]	pServerInterface	INTERFACE implementation instance. This will be the Server Object retrieved by IBindingClient::GetServerObject and IBindingProxy::GetServerObject

Returns

Standard Result Code

flush()

template<typename WRITER_TYPE>

WRITER_TYPE & adtf::streaming::ant::flush

(

WRITER_TYPE &

oWriter

)

Global function template to flush a writer.

Template Parameters

WRITER_TYPE

Type or sub class of cSampleWriter

Returns

Returns the flushed streamer

See also

cSampleWriter

get_default_buffer_factory()

tResult adtf::streaming::ant::get_default_buffer_factory

(

adtf::ucom::iobject_ptr< ISampleBufferFactory > &

pFactory

)

Creates and gets the default buffer factory (ISampleBufferFactory) based on new/delete. The ISampleBuffer returned by the ISampleBufferFactory::GetBuffer will use new / delete on each ISampleBufferFactory::Resize call.

Parameters

[out]

pFactory

The factory returned

Returns

Standard Result Code

Return values

ERR_POINTER	The factory could not be created due memory allocation error.
ERR_INVALID_INTERFACE	The given pFactory did not accept the adtf::ucom::iobject_ptr::Reset call.

get_named_graph_object_from_graph()

tResult adtf::streaming::ant::get_named_graph_object_from_graph	(	IGraph &	oGraph,
		const char *	strName,
		ucom::ant::iobject_ptr< ucom::ant::IObject > &	pObjectFound )

Helper function to retrieve a graph object from a graph with fully qualified unique name of an object.

Parameters

[in]	oGraph	The graph instance to get the object from.
[in]	strName	The fully qualified named with dots (i.e. "streaminggraph.myfiltergraph.mysubgraph.myfilter")
[in,out]	pObjectFound	The object to retrieve

Returns

...

Remarks

Expensive recursive call !!

get_named_graph_object_full_name() [1/2]

adtf_util::cString adtf::streaming::ant::get_named_graph_object_full_name

(

const INamedGraphObject &

oGraphObject

)

Helper function to retrieve a full qualified unique name of an object registered in IFilterGraph.

Parameters

[in]

oGraphObject

The object to retrieve the fullname for.

Returns

The full qualified name of the object. (i.e. "streaminggraph.myfiltergraph.mysubgraph.myfilter")

Remarks

Expensive recursive call !!

get_named_graph_object_full_name() [2/2]

adtf_util::cString adtf::streaming::ant::get_named_graph_object_full_name	(	const INamedGraphObject &	oGraphObject,
		const char *	strSeperator )

Helper function to retrieve a full qualified unique name of an object registered in IFilterGraph.

Parameters

[in]	oGraphObject	The object to retrieve the fullname for.
[in]	strSeperator	The seperator to use between the parent object names.

Returns

The full qualified name of the object. (i.e. "streaminggraph.myfiltergraph.mysubgraph.myfilter")

Remarks

Expensive recursive call !!

get_property() [1/2]

template<typename VALUETYPE>

VALUETYPE adtf::streaming::ant::get_property	(	const IStreamType &	oStreamType,
		const char *	strNameOfValue )

Gets the property of the given oStreamType.

Template Parameters

VALUETYPE

Type of value returned

Parameters

[in]	oStreamType	StreamType where to get the property
[in]	strNameOfValue	name of the property

Returns

the value of the property

get_property() [2/2]

template<typename VALUETYPE>

VALUETYPE adtf::streaming::ant::get_property	(	const IStreamType &	oStreamType,
		const char *	strNameOfValue,
		VALUETYPE	oDefaultValue )

Gets the property of the given oStreamType.

Template Parameters

VALUETYPE

Type of value returned and oDefaultValue

Parameters

[in]	oStreamType	StreamType where to get the property
[in]	strNameOfValue	name of the property
[in]	oDefaultValue	default value of property if not found.

Returns

the value of the property

get_reference_buffer_factory()

tResult adtf::streaming::ant::get_reference_buffer_factory

(

adtf::ucom::iobject_ptr< ISampleBufferFactory > &

pFactory

)

Creates and gets the a buffer factory that creates sample buffers that do not copy the data, but only keep a reference to it. Use this with EXTREME care!! Keep samples that use these buffers in a adtf::ucom::ant::weak_object_ptr in order to be able to check if they no longer exist before you manipulate the data again.

Parameters

[out]

pFactory

The factory returned

Returns

Standard Result Code

Return values

ERR_POINTER	The factory could not be created due memory allocation error.
ERR_INVALID_INTERFACE	The given pFactory did not accept the adtf::ucom::iobject_ptr::Reset call.

get_sample_info() [1/4]

adtf::util::cVariant adtf::streaming::ant::get_sample_info	(	const ISample &	oSample,
		const ISampleInfo::tHashKey &	oHash )

Retrieves a variant value for the hash key oHash out of the samples (oSample) sample information. If the value does not exists the return value content is undefined.

Parameters

[in]	oSample	The sample to retrieve the value from its sample information.
[in]	oHash	The hash key of the value.

Returns

retrieved value as variant.

get_sample_info() [2/4]

adtf::util::cVariant adtf::streaming::ant::get_sample_info	(	const ISample &	oSample,
		const ISampleInfo::tHashKey &	oHash,
		const adtf::util::cVariant	oDefault )

Retrieves a variant value for the hash key oHash out of the samples (oSample) sample information. If the value does not exists the return value is the given defaultoDefault.

Parameters

[in]	oSample	The sample to retrieve the value from its sample information.
[in]	oHash	The hash key of the value.
[in]	oDefault	default value if value does not exist.

Returns

retrieved value as variant.

get_sample_info() [3/4]

adtf::util::cVariant adtf::streaming::ant::get_sample_info	(	const ISampleInfo &	oSampleInfo,
		const ISampleInfo::tHashKey &	oHash )

Retrieves a variant value for the hash key oHash out of the sample information oSampleInfo . If the value does not exists the return value content is undefined.

Parameters

[in]	oSampleInfo	The sample information to retrieve the value from.
[in]	oHash	The hash key of the value.

Returns

retrieved value as variant.

get_sample_info() [4/4]

adtf::util::cVariant adtf::streaming::ant::get_sample_info	(	const ISampleInfo &	oSampleInfo,
		const ISampleInfo::tHashKey &	oHash,
		const adtf::util::cVariant	oDefault )

Retrieves a variant value for the hash key oHash out of the sample information oSampleInfo . If the value does not exists the return value is the given defaultoDefault.

Parameters

[in]	oSampleInfo	The sample information to retrieve the value from.
[in]	oHash	The hash key of the value.
[in]	oDefault	default value if value does not exist.

Returns

retrieved value as variant.

get_stream_type_image_format()

tResult adtf::streaming::ant::get_stream_type_image_format	(	tStreamImageFormat &	oFormat,
		const IStreamType &	oType )

Helper function to retrieve the oFormat (tStreamImageFormat) out of the of a IStreamType for a stream_meta_type_image.

Parameters

oType	Stream Type where to get the properties from
oFormat	Format to set the properties content to.

Returns

tResult

See also

stream_meta_type_image

get_streaming_graph_object()

tResult adtf::streaming::ant::get_streaming_graph_object	(	const IStreamingGraph &	oGraph,
		ucom::ant::iobject_ptr< ucom::ant::IObject > &	pObject )

Retrieve the first item of the streaming graph where the iobject_ptr::Reset returns ERR_NOERROR If pObject is used with adtf::ucom::object_ptr this method will return the first object of given INTERFACE of adtf::ucom::object_ptr<INTERFACE>. The embedded Filter Graph is not considered.

 // ...
 adtf::ucom::object_ptr<adtf::streaming::IStreamingGraph> pStreamingGraph;
 adtf::services::get_session_streaming_graph(pStreamingGraph);
 adtf::ucom::object_ptr<ISampleStreamingSource> pFirstFoundSource;
 get_streaming_graph_object(*pFilterGraph, pFirstFoundSource);
// ...

Parameters

[in]	oGraph	Graph to retrieve the object from.
[in,out]	pObject	The object reference to return the value.

Return values

ERR_NOT_FOUND	iobject_ptr::Reset never returned ERR_NOERROR
ERR_NOERRROR	iobject_ptr::Reset returned ERR_NOERROR, consider pObject

See also

tResult adtf::services::ant::get_session_filtergraph() to retrieve the current Filter Graph.

get_streaming_graph_objects()

tResult adtf::streaming::ant::get_streaming_graph_objects	(	const IStreamingGraph &	oGraph,
		ucom::ant::iobject_enum< ucom::ant::IObject > &	lstObjects )

Retrieve all items of the streaming graph where the iobject_ptr::Reset returns ERR_NOERROR

Parameters

[in]	oGraph	Graph to retrieve the object from.
[in,out]	lstObjects	The object list reference to return the values to.

See also

tResult adtf::services::ant::get_session_filtergraph() to retrieve the current Filter Graph.

make_sample_reader()

tResult adtf::streaming::ant::make_sample_reader ( cSampleReader & oReader, const char * strNameOfReader, const ucom::iobject_ptr< const IStreamType > & pStreamType )

inline

Initializes a cSampleReader with given name and StreamType param[in] oReader Reader to intialize param[in] strName Name to set param[in] pStreamType Stream Type to set. A deep copy will be created.

Returns

Result of cSampleReader::SetType

make_sample_writer()

tResult adtf::streaming::ant::make_sample_writer ( cSampleWriter & oWriter, const char * strNameOfWriter, const ucom::ant::iobject_ptr< const IStreamType > & pStreamType )

inline

• Initializes the given oWriter with name and type.

  Parameters

  [in]	oWriter	writer to initializes
  [in]	strNameOfWriter	name sets to the writer
  [in]	pStreamType	stream for the writer (deep copy is created)

  Returns

  Standard Result Code

operator!=() [1/4]

template<typename T>

bool adtf::streaming::ant::operator!=	(	const IStreamType &	oStreamType,
		T	oValue )

The not-equality operator returns false only if the given oStreamType is not an instance of the stream_meta_type in T. It will compare the unique meta type name.

Template Parameters

T	A class definition that fulfil the concept of defining the unique meta type name in a variable MetaTypeName (see stream_meta_type)

Parameters

oStreamType	The Stream Type instance to check the unique meta type name.
oValue	the Stream Meta Type to expected

Return values

true	meta type name is not equal
false	meta type name is equal

operator!=() [2/4]

bool adtf::streaming::ant::operator!= ( const IStreamType & oStreamTypeLeft, const IStreamType & oStreamTypeRight )

inline

The not-equality operator returns false only if the given oStreamTypeLeft has the exact same properties and property values as oStreamTypeRight. This works in both ways.

Parameters

oStreamTypeLeft	The left Stream Type instance for comparison
oStreamTypeRight	The Stream Type instance to compare with

Return values

true	types are not equal
false	types are equal

operator!=() [3/4]

bool adtf::streaming::ant::operator!=	(	const tStreamImageFormat &	sLeft,
		const tStreamImageFormat &	sRight )

is not equal operator to compare tStreamImageFormat

Parameters

sLeft	[in] left value
sRight	[in] right value

Return values

true	is not equal
false	is equal

operator!=() [4/4]

template<typename T, typename std::enable_if_t< flash::is_stream_meta_type< T >::value, int > = 0>

bool adtf::streaming::ant::operator!=	(	const ucom::ant::iobject_ptr< const IStreamType > &	pStreamType,
		const T &	oValue )

The equality operator returns true only if the given pStreamType is an instance of the stream_meta_type in T. It will compare the unique meta type name.

Template Parameters

T	A class definition that fulfil the concept of defining the unique meta type name in a variable MetaTypeName (see stream_meta_type)

Parameters

pStreamType	The Stream Type instance to check the unique meta type name.
oValue	the Stream Meta Type (not) expected

Return values

true	meta type name is not equal
false	meta type name is equal

operator<<() [1/11]

cSampleWriter & adtf::streaming::ant::operator<< ( cSampleWriter & oSampleWriter, const tResult & oError )

inline

Streaming Operator<< to write/set a error to the cSampleWriter

See also

cSampleWriter::SetStreamError

Parameters

oSampleWriter	[in] The Writer to set the error reference.
oError	[in] The error reference which will be set on oSampleWriter

Returns

...

operator<<() [2/11]

cSampleWriter & adtf::streaming::ant::operator<< ( cSampleWriter & oSampleWriter, const ucom::ant::iobject_ptr< const ISample > & pSample )

inline

Streaming Operator<< to write/transmit a sample to the cSampleWriter

See also

cSampleWriter::Transmit

Parameters

oSampleWriter	[in] The Writer to transmit the sample reference to.
pSample	[in] The Sample reference which will be transmitted on oSampleWriter

Returns

the writers instance

Note

rtsafe{using Sample Pool Service and a Memory Allocator Service and the sample stream connected has a static queue}

operator<<() [3/11]

cSampleWriter & adtf::streaming::ant::operator<< ( cSampleWriter & oSampleWriter, const ucom::ant::iobject_ptr< const IStreamType > & pType )

inline

Streaming Operator<< to write/change a StreamType to the cSampleWriter

See also

cSampleWriter::ChangeType

Parameters

oSampleWriter	[in] The Writer to change the StreamType reference.
pType	[in] The StreamType reference which will be change and write on oSampleWriter

Returns

...

operator<<() [4/11]

cSampleWriter & adtf::streaming::ant::operator<< ( cSampleWriter & oSampleWriter, const ucom::ant::iobject_ptr< ISample > & pSample )

inline

Streaming Operator<< to write/transmit a sample to the cSampleWriter

See also

cSampleWriter::Transmit

Parameters

oSampleWriter	[in] The Writer to transmit the sample reference to.
pSample	[in] The Sample reference which will be transmitted on oSampleWriter

Returns

...

operator<<() [5/11]

cSampleWriter & adtf::streaming::ant::operator<< ( cSampleWriter & oSampleWriter, cSampleWriter &(* pStreamfunc )(cSampleWriter &) )

inline

Streaming Operator<< to flush or to write the cSampleWriter

See also

cSampleWriter::Flush

Parameters

oSampleWriter	[in] The Writer to execute the function to.
pStreamfunc	[in] the streamfunction to execute with the layout: cSampleWriter&(cSampleWriter&)

Returns

...

operator<<() [6/11]

ISampleOutStream & adtf::streaming::ant::operator<< ( ISampleOutStream & oStreamWriter, const adtf::ucom::ant::iobject_ptr< const ISample > & pSample )

inline

Streaming Operator<< to write a sample to a writers queue of the ISampleStream

See also

ISampleOutStream::Write

Parameters

oStreamWriter	[in] The Writer to write to.
pSample	[in] The Sample which will be written to queue.

Returns

...

operator<<() [7/11]

ISampleOutStream & adtf::streaming::ant::operator<< ( ISampleOutStream & oStreamWriter, const adtf::ucom::ant::iobject_ptr< const IStreamType > & pStreamType )

inline

Streaming Operator<< to write a stream type to a writers queue of the ISampleStream

See also

ISampleOutStream::Write

Parameters

oStreamWriter	[in] The Writer to write to.
pStreamType	[in] The StreamType which will be written to queue.

Returns

...

operator<<() [8/11]

ISampleOutStream & adtf::streaming::ant::operator<< ( ISampleOutStream & oStreamWriter, const adtf::ucom::ant::iobject_ptr< IStreamType > & pStreamType )

inline

Streaming Operator<< to write an stream type to a writers queue of the ISampleStream

See also

ISampleOutStream::Write

Parameters

oStreamWriter	[in] The Writer to write to.
pStreamType	[in] The StreamType which will be written to queue.

Returns

...

operator<<() [9/11]

ISampleOutStream & adtf::streaming::ant::operator<< ( ISampleOutStream & oStreamWriter, const tResult & oErr )

inline

Streaming Operator<< to write an Error to the ISampleStream.

See also

ISampleOutStream::SetStreamError

Parameters

oStreamWriter	[in] The Writer to write to.
oErr	[in] The Error which will be written to queue.

Returns

return manipulated oStreamWriter instance

operator<<() [10/11]

ISampleOutStream & adtf::streaming::ant::operator<< ( ISampleOutStream & oStreamWriter, ISampleOutStream &(* pStreamfunc )(ISampleOutStream &) )

inline

Streaming Operator<< to call a certain streaming function (manipulator), use i.e. to flush the queue:

pWriter << adtf::streaming::flush;

See also

ISampleOutStream::Flush

Parameters

[in]	oStreamWriter	The Writer to call the streaming function to.
[in]	pStreamfunc	streaming function to execute with layout: ISampleOutStream&(ISampleOutStream&)

Returns

return manipulated oStreamWriter instance

operator<<() [11/11]

template<typename DATA_TYPE>

sample_writer< DATA_TYPE > & adtf::streaming::ant::operator<<	(	sample_writer< DATA_TYPE > &	oSampleWriter,
		const DATA_TYPE &	oSampleData )

Streaming Operator<< to write/transmit a sample to the cSampleWriter

See also

sample_writer::Transmit

Parameters

oSampleWriter	[in] The Writer to transmit the sample reference to.
oSampleData	[in] the data to write

Returns

The writers instance

Note

rtsafe{using Sample Pool Service and a Memory Allocator Service}

Deprecated

Use sample_writer<DATA_TYPE>::Write(tmTime, oSampleData) instead.

operator==() [1/4]

template<typename T>

bool adtf::streaming::ant::operator==	(	const IStreamType &	oStreamType,
		T	)

The equality operator returns true only if the given oStreamType is an instance of the stream_meta_type in T. It will compare the unique meta type name.

Template Parameters

T	A class definition that fulfil the concept of defining the unique meta type name in a variable MetaTypeName (see stream_meta_type)

Parameters

oStreamType

The Stream Type instance to check the unique meta type name.

Return values

true	meta type name is equal
false	meta type name is not equal

operator==() [2/4]

bool adtf::streaming::ant::operator== ( const IStreamType & oStreamTypeLeft, const IStreamType & oStreamTypeRight )

inline

The equality operator returns true only if the given oStreamTypeLeft has the exact same properties and property values as oStreamTypeRight. This works in both ways.

Parameters

oStreamTypeLeft	The left Stream Type instance for comparison
oStreamTypeRight	The Stream Type instance to compare with

Return values

true	types are equal
false	type are not equal

operator==() [3/4]

bool adtf::streaming::ant::operator==	(	const tStreamImageFormat &	sLeft,
		const tStreamImageFormat &	sRight )

is equal operator to compare tStreamImageFormat

Parameters

sLeft	[in] left value
sRight	[in] right value

Return values

true	is equal
false	is not equal

operator==() [4/4]

template<typename T, typename std::enable_if_t< flash::is_stream_meta_type< T >::value, int > = 0>

bool adtf::streaming::ant::operator==	(	const ucom::ant::iobject_ptr< const IStreamType > &	pStreamType,
		const T &	oValue )

The equality operator returns true only if the given pStreamType is an instance of the stream_meta_type in T. It will compare the unique meta type name.

Template Parameters

T	A class definition that fulfil the concept of defining the unique meta type name in a variable MetaTypeName (see stream_meta_type)

Parameters

pStreamType	The Stream Type instance to check the unique meta type name.
oValue	the Stream Meta Type expected

Return values

true	meta type name is equal
false	meta type name is not equal

operator>>() [1/6]

const ISampleInStream & adtf::streaming::ant::operator>> ( const ISampleInStream & oStreamReader, IStreamItem & oItem )

inline

Streaming Operator>> to read a sample from the readers queue.

Remarks

Intialize the passed oItem with tReadingEvent::RE_Nothing to react on empty queues!

See also

ISampleInStream::Read

Parameters

oStreamReader	[in] The Reader to read from.
oItem	[in] The item implemenation to read to (see IStreamItem for default implementation).

Returns

...

operator>>() [2/6]

cSampleReader & adtf::streaming::ant::operator>> ( cSampleReader & oSampleReader, cSampleReader &(* pStreamfunc )(cSampleReader &) )

inline

Streaming Operator>> to clear the cSampleReaders Queue

See also

cSampleReader::Clear

Parameters

[in]	oSampleReader	The Reader to execute he function to.
[in]	pStreamfunc	the streamfunction to execute with the layout: cSampleReader&(cSampleReader&)

Returns

return the oSampleReader after executed streamfunction!

operator>>() [3/6]

cSampleReader & adtf::streaming::ant::operator>> ( cSampleReader & oSampleReader, cSampleWriter & oSampleWriter )

inline

Streaming Operator>> to transmit all samples from the oSampleReader to the oSampleWriter

Parameters

oSampleReader	[in] The Reader to read the streamdata.
oSampleWriter	[in] The writer to write teh streamdata to.

Returns

teh reader with new state.

operator>>() [4/6]

template<typename DATATYPE>

cSampleReader & adtf::streaming::ant::operator>>	(	cSampleReader &	oSampleReader,
		sample_data< DATATYPE > &	oSampleData )

Streaming Operator>> to get the next sample from the cSampleReader

See also

cSampleReader::GetNextSample

Parameters

oSampleReader	[in] The Reader to get the next sample from queue.
oSampleData	[in] The Sample data to read the

Returns

the sample reader with new state after reading

operator>>() [5/6]

cSampleReader & adtf::streaming::ant::operator>> ( cSampleReader & oSampleReader, ucom::ant::iobject_ptr< const ISample > & pSample )

inline

::* Streaming Operator>> to get the next sample from the cSampleReader

See also

cSampleReader::GetNextSample

Parameters

oSampleReader	[in] The Reader to get the next sample from queue.
pSample	[in] The Sample reference to store the next sample from oSampleReader

Returns

...

operator>>() [6/6]

cSampleReader & adtf::streaming::ant::operator>> ( cSampleReader & oSampleReader, ucom::ant::iobject_ptr< const IStreamType > & pType )

inline

Streaming Operator>> to write/change a StreamType to the cSampleReader

See also

cSampleReader::ChangeType

Parameters

oSampleReader	[in] The Reader to get StreamType reference.
pType	[in] The StreamType reference to store the stream type

Returns

...

R()

adtf::streaming::ant::R

(

8

)

Format definition.

Format definition this description means always first in lowest bit of lowest byte

read_from_sample()

template<typename T>

tResult adtf::streaming::ant::read_from_sample	(	const ISample &	oSample,
		T &	oValue )

Helper to read the value oValue from the sample oSample. This will Locks the Sample and copy the memory from the SampleBuffer to the memory of oSample.

Parameters

[in]

oSample

The Sample to read from.

Template Parameters

T	The Type of oValue

Parameters

[in]

oValue

The value to read.

Remarks

This must be a plain data type (c-style structure or basic type) or at least an standrad layout type.

Returns

Standard Error Code of ISampleBuffer::Read

set_property() [1/2]

tResult adtf::streaming::ant::set_property ( IStreamType & oStreamType, const char * strNameOfValue, const char * poValue )

inline

Sets the property of the given oStreamType to the cString value poValue

Parameters

[in]	oStreamType	StreamType where to set the property
[in]	strNameOfValue	name of the property
[in]	poValue	string value of property to set.

Returns

Standard Result Code

set_property() [2/2]

template<typename VALUETYPE>

tResult adtf::streaming::ant::set_property	(	IStreamType &	oStreamType,
		const char *	strNameOfValue,
		VALUETYPE	oValue )

Sets the property of the given oStreamType to the value oValue

Template Parameters

VALUETYPE

Type of oValue

Parameters

[in]	oStreamType	StreamType where to set the property
[in]	strNameOfValue	name of the property
[in]	oValue	value of property to set.

Returns

Standard Result Code

set_sample_info() [1/2]

tResult adtf::streaming::ant::set_sample_info	(	ISample &	oSample,
		const ISampleInfo::tHashKey &	oHash,
		const adtf::util::cVariant	oValue )

Sets a variant value for the hash key oHash into the sample oSample sample information.

Parameters

[in]	oSample	The sample to set the value to its sample information.
[in]	oHash	The hash key of the value.
[in]	oValue	value to set.

Returns

standard error code

Return values

ERR_NOERROR	value is set
ERR_INVALID_TYPE	Type is not supported. See base::ant::IHashValueMapValue::tType

set_sample_info() [2/2]

tResult adtf::streaming::ant::set_sample_info	(	ISampleInfo &	oSampleInfo,
		const ISampleInfo::tHashKey &	oHash,
		const adtf::util::cVariant	oValue )

Sets a variant value for the hash key oHash into the sample information oSampleInfo.

Parameters

[in]	oSampleInfo	The sample information to set the value to.
[in]	oHash	The hash key of the value.
[in]	oValue	value to set.

Returns

standard error code

Return values

ERR_NOERROR	value is set
ERR_INVALID_TYPE	Type is not supported. See base::ant::IHashValueMapValue::tType

set_stream_type_image_format()

tResult adtf::streaming::ant::set_stream_type_image_format	(	IStreamType &	oType,
		const tStreamImageFormat &	oFormat )

Helper function to set the properties of a IStreamType for a stream_meta_type_image.

Parameters

oType	Stream Type where to set the properties representing the content of sFormat tStreamImageFormat
oFormat	Format to set the properties from.

Returns

tResult

See also

stream_meta_type_image

stream_image_format_get_generic_mask()

uint32_t adtf::streaming::ant::stream_image_format_get_generic_mask	(	const char *	strChannel,
		const tStreamImageFormat &	strFormat )

Retrieves the pixelsize

Parameters

strChannel	[in] channel to look for.
strFormat	[in] a generic stream image format.

Returns

Returns the pixelsize in bits

stream_image_format_get_generic_pixel_size()

unsigned int adtf::streaming::ant::stream_image_format_get_generic_pixel_size

(

const tStreamImageFormat &

strFormat

)

Retrieves the pixelsize

Parameters

strFormat

[in] a generic stream image format.

Returns

Returns the pixelsize in bits

stream_image_format_is_generic()

bool adtf::streaming::ant::stream_image_format_is_generic

(

const tStreamImageFormat &

strFormat

)

Check if all bits are well defined and at least one component is available

Parameters

strFormat

[in] a generic stream image format.

Returns

Returns true when one or more component is specified and all bits are assigned

stream_image_format_is_generic_rgb()

bool adtf::streaming::ant::stream_image_format_is_generic_rgb

(

const tStreamImageFormat &

strFormat

)

Check if R, G and B components are available.

Parameters

[in]

strFormat

a generic stream image format.

Returns

Returns true when R, G and B component including bitsize is specified

trigger()

template<typename WRITER_TYPE>

WRITER_TYPE & adtf::streaming::ant::trigger

(

WRITER_TYPE &

oWriter

)

Global function template to trigger a writers sample stream manually.

Template Parameters

WRITER_TYPE

Type or sub class of cSampleWriter

Returns

Returns the triggered streamer

See also

cSampleWriter, sample stream.

write_to_sample()

template<typename T>

tResult adtf::streaming::ant::write_to_sample	(	ISample &	oSample,
		const T &	oValue )

Helper to write the value oValue to the sample oSample. This will WriteLock the Sample and copy the memory to the SampleBuffer of Sample.

Parameters

[in]

oSample

The Sample to write to. (mind you must set a still a timestamp to the sample, see ISample::SetTime)

Template Parameters

T	The Type of oValue

Parameters

[in]

oValue

The value to write.

Remarks

This must be a plain data type (c-style structure or basic type) or at least an standrad layout type.

Returns

Standard Error Code of ISampleBuffer::Write