adtf::streaming::ant::IStreamType Class Reference

Defines access methods for the interface of a Stream Type. More...

#include <streamtype_intf.h>

Inherits adtf::ucom::ant::IObject.

Public Member Functions
	ADTF_IID (IStreamType, "streamtype.ant.streaming.adtf.iid")
	Interface ID for the Stream Type interface.
virtual tResult	GetMetaTypeName (base::ant::IString &&strTypeName) const =0
	Get the meta type name of this instance.
virtual adtf::util::tVersion	GetVersion () const =0
	Get version of this instance of the StreamMetaType.
virtual tResult	GetConfig (ucom::ant::iobject_ptr< base::ant::IProperties > &pProperties)=0
	Get all properties of a Stream Type (read/write)
virtual tResult	GetConfig (ucom::ant::iobject_ptr< const base::ant::IProperties > &pProperties) const =0
	Get all properties of a Stream Type (read only) - const correct.
virtual tResult	GetMetaType (ucom::ant::iobject_ptr< const IStreamMetaType > &pMetaType) const =0
	Get the Stream Meta Type definition of the Stream Type.
Public Member Functions inherited from adtf::ucom::ant::IObject
	ADTF_IID (IObject, "object.ant.ucom.adtf.iid")

Protected Member Functions
	~IStreamType ()=default
	not destructable
Protected Member Functions inherited from adtf::ucom::ant::IObject
	~IObject ()=default
	Protected destructor --> Only the final implementation can be destroyed!

Detailed Description

Defines access methods for the interface of a Stream Type.

The IStreamType interface reflects the class which is used to instantiate objects of Stream Types as described in stream meta type

Member Function Documentation

GetConfig() [1/2]

virtual tResult adtf::streaming::ant::IStreamType::GetConfig ( ucom::ant::iobject_ptr< base::ant::IProperties > & pProperties )

pure virtual

Get all properties of a Stream Type (read/write)

Parameters

[out]

pProperties

All properties of a Stream Type (can be modified)

Returns

Standard error code

Return values

ERR_NOERROR

Everything went fine

GetConfig() [2/2]

virtual tResult adtf::streaming::ant::IStreamType::GetConfig ( ucom::ant::iobject_ptr< const base::ant::IProperties > & pProperties ) const

pure virtual

Get all properties of a Stream Type (read only) - const correct.

Parameters

[out]

pProperties

All properties of a Stream Type

Returns

Standard error code

Return values

ERR_NOERROR

Everything went fine

GetMetaType()

virtual tResult adtf::streaming::ant::IStreamType::GetMetaType ( ucom::ant::iobject_ptr< const IStreamMetaType > & pMetaType ) const

pure virtual

Get the Stream Meta Type definition of the Stream Type.

Parameters

[out]

pMetaType

The Stream Meta Type definition of this Stream Type

Returns

Standard error code

Return values

ERR_NOERROR

Everything went fine

GetMetaTypeName()

virtual tResult adtf::streaming::ant::IStreamType::GetMetaTypeName ( base::ant::IString && strTypeName ) const

pure virtual

Get the meta type name of this instance.

Returns

Standard error code

Parameters

[out]

strTypeName

The meta type name as string

Return values

ERR_NOERROR

Everything went fine

GetVersion()

virtual adtf::util::tVersion adtf::streaming::ant::IStreamType::GetVersion ( ) const

pure virtual

Get version of this instance of the StreamMetaType.

Returns

Version of the StreamMetaType instantiated.

See also

adtf_util::tVersion

---

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

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