adtf::streaming::ant::cStreamItem Class Reference

#include <streamitem_intf.h>

Inherits adtf::streaming::ant::IStreamItem.

Public Member Functions
constexpr	cStreamItem () noexcept
	CTOR.
	cStreamItem (const IStreamItem &oItem)
constexpr	cStreamItem (const ucom::ant::iobject_ptr< const ISample > &pSample) noexcept
constexpr	cStreamItem (const ucom::ant::iobject_ptr< const IStreamType > &pStreamType) noexcept
	cStreamItem (const cStreamItem &oOther) noexcept
	copy CTOR
	cStreamItem (cStreamItem &&oOther) noexcept
	move CTOR
cStreamItem &	operator= (const cStreamItem &)=default
	copy operator
cStreamItem &	operator= (cStreamItem &&)=default
	move operator
tType	GetType () const noexcept override
tResult	GetObject (ucom::ant::iobject_ptr< const ucom::ant::IObject > &pObject) const noexcept override
tResult	GetSample (ucom::ant::iobject_ptr< const ISample > &pSample) const noexcept override
tResult	GetStreamType (ucom::ant::iobject_ptr< const IStreamType > &pStreamType) const noexcept override
tResult	SetSample (const ucom::ant::iobject_ptr< const ISample > &pSample) noexcept override
tResult	SetStreamType (const ucom::ant::iobject_ptr< const IStreamType > &pStreamType) noexcept override
tResult	CopyTo (IStreamItem &oDest) const noexcept

Additional Inherited Members
Public Types inherited from adtf::streaming::ant::IStreamItem
enum class	tType : uint32_t { Undefined = 0 , StreamType = 1 , Sample = 2 }
	serval types are defined More...
Protected Member Functions inherited from adtf::streaming::ant::IStreamItem
	~IStreamItem ()=default
	not destructable

Detailed Description

Default implementation of an StreamItem as container of the sample stream s Queue

Constructor & Destructor Documentation

cStreamItem() [1/3]

adtf::streaming::ant::cStreamItem::cStreamItem ( const IStreamItem & oItem )

inline

copy CTOR from interface

Parameters

oItem

[in] item to copy

cStreamItem() [2/3]

adtf::streaming::ant::cStreamItem::cStreamItem ( const ucom::ant::iobject_ptr< const ISample > & pSample )

inlineconstexprnoexcept

initializer CTOR

Parameters

pSample

[in] sample to set immediately

cStreamItem() [3/3]

adtf::streaming::ant::cStreamItem::cStreamItem ( const ucom::ant::iobject_ptr< const IStreamType > & pStreamType )

inlineconstexprnoexcept

initializer CTOR

Parameters

pStreamType

[in] StreamType to set immediately

Member Function Documentation

CopyTo()

tResult adtf::streaming::ant::cStreamItem::CopyTo ( IStreamItem & oDest ) const

inlinenoexcept

Copy its content to the oDest container

Parameters

oDest

[in] Destination item to copy the content to.

Returns

Result code of the SetStreamType or SetSample call.

Return values

ERR_INVALID_TYPE

The content of this item is not initialized.

GetObject()

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

inlineoverridevirtualnoexcept

Retrieves the object of the StreamItem.

Remarks

Mind, this could result in a ucom_cast call!

Return values

ERR_NOERROR

Object successfully retrieved

Implements adtf::streaming::ant::IStreamItem.

GetSample()

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

inlineoverridevirtualnoexcept

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

Implements adtf::streaming::ant::IStreamItem.

GetStreamType()

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

inlineoverridevirtualnoexcept

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

Implements adtf::streaming::ant::IStreamItem.

GetType()

tType adtf::streaming::ant::cStreamItem::GetType ( ) const

inlineoverridevirtualnoexcept

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

Returns

Returns the type of the sample item

Implements adtf::streaming::ant::IStreamItem.

SetSample()

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

inlineoverridevirtualnoexcept

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

Implements adtf::streaming::ant::IStreamItem.

SetStreamType()

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

inlineoverridevirtualnoexcept

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

Implements adtf::streaming::ant::IStreamItem.

---

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

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