adtf::streaming::ant::IStreamItem Class Reference

#include <streamitem_intf.h>

Inherited by adtf::streaming::ant::cStreamItem.

Public Types
enum class	tType : uint32_t { Undefined = 0 , StreamType = 1 , Sample = 2 }
	serval types are defined More...

Public Member Functions
virtual tType	GetType () const =0
virtual tResult	GetObject (ucom::ant::iobject_ptr< const ucom::ant::IObject > &pObject) const =0
virtual tResult	GetSample (ucom::ant::iobject_ptr< const ISample > &pSample) const =0
virtual tResult	GetStreamType (ucom::ant::iobject_ptr< const IStreamType > &pStreamType) const =0
virtual tResult	SetSample (const ucom::ant::iobject_ptr< const ISample > &pSample)=0
virtual tResult	SetStreamType (const ucom::ant::iobject_ptr< const IStreamType > &pStreamType)=0

Protected Member Functions
	~IStreamItem ()=default
	not destructable

Detailed Description

The IStreamItem interface is the base type for all object which are passed through a stream

Member Enumeration Documentation

tType

enum class adtf::streaming::ant::IStreamItem::tType : uint32_t

strong

serval types are defined

Enumerator
StreamType	item is a IStreamType. Mind: All StreamType changes will be queue too !!
Sample	item is a queue item contains a ISample

Member Function Documentation

GetObject()

virtual tResult adtf::streaming::ant::IStreamItem::GetObject ( ucom::ant::iobject_ptr< const ucom::ant::IObject > & pObject ) const

pure virtual

Retrieves the object of the StreamItem.

Remarks

Mind, this could result in a ucom_cast call!

Return values

ERR_NOERROR

Object successfully retrieved

Implemented in adtf::streaming::ant::cStreamItem, and adtf::streaming::cStreamItem.

GetSample()

virtual tResult adtf::streaming::ant::IStreamItem::GetSample ( ucom::ant::iobject_ptr< const ISample > & pSample ) const

pure virtual

Retrieves the sample of the StreamItem if GetType is tType::Sample

The StreamItem was created to prevent ucom_casts call while transmissions and to define clearly which items are supported.

Return values

ERR_NOERROR

Sample successfully retrieved

Implemented in adtf::streaming::ant::cStreamItem, and adtf::streaming::cStreamItem.

GetStreamType()

virtual tResult adtf::streaming::ant::IStreamItem::GetStreamType ( ucom::ant::iobject_ptr< const IStreamType > & pStreamType ) const

pure virtual

Retrieves the StreamType of the StreamItem if GetType is tType::StreamType

The StreamItem was created to prevent ucom_casts call while transmissions and to define clearly which items are supported.

Return values

ERR_NOERROR

StreamType successfully retrieved

Implemented in adtf::streaming::ant::cStreamItem, and adtf::streaming::cStreamItem.

GetType()

virtual tType adtf::streaming::ant::IStreamItem::GetType ( ) const

pure virtual

Retrieves the type of the sample item. See tType for more info.

Returns

Returns the type of the sample item

Implemented in adtf::streaming::ant::cStreamItem, and adtf::streaming::cStreamItem.

SetSample()

virtual tResult adtf::streaming::ant::IStreamItem::SetSample ( const ucom::ant::iobject_ptr< const ISample > & pSample )

pure virtual

Sets a Sample to the StreamItem container and set tType::Sample

The StreamItem was created to prevent ucom_casts call while transmissions and to define clearly which items are supported.

Parameters

pSample

[in] Sample to set

Return values

ERR_NOERROR

Sample successfully set

Implemented in adtf::streaming::ant::cStreamItem, and adtf::streaming::cStreamItem.

SetStreamType()

virtual tResult adtf::streaming::ant::IStreamItem::SetStreamType ( const ucom::ant::iobject_ptr< const IStreamType > & pStreamType )

pure virtual

Sets a StreamType to the StreamItem container and set tType::StreamType

The StreamItem was created to prevent ucom_casts call while transmissions and to define clearly which items are supported.

Parameters

pStreamType

[in] StreamType to set

Return values

ERR_NOERROR

Sample successfully set

Implemented in adtf::streaming::ant::cStreamItem, and adtf::streaming::cStreamItem.

---

The documentation for this class was generated from the following file:

• src/libraries/streaming3/include/adtfstreaming3/streamitem_intf.h