adtf::streaming::ant::cStreamMetaType Class Reference

#include <streamtype.h>

Inherits adtf::ucom::catwo::object< IStreamMetaType >.

Inherited by adtf::streaming::ant::stream_meta_type< MetaTypeStruct >, and adtf::streaming::hollow::cCamelionStreamMetaType.

Public Member Functions
tResult	GetMetaTypeName (IString &&strTypeName) const override
	Gets the unique meta type name.
adtf::util::tVersion	GetVersion () const override
	Get version of a Stream Type.
tResult	GetDefaultConfig (adtf::ucom::ant::iobject_ptr< const adtf::base::IProperties > &pProperties) const override
	Get the default configuration values for a Stream Type.
tResult	GetParent (adtf::ucom::ant::iobject_ptr< const IStreamMetaType > &pParent) const override
	This GetParent function is deprecated.
tResult	IsCompatible (const IStreamType &oTypeToCheck, const IStreamType &oTypeExpected) const override
	Compares the oTypeExpected Stream Type with the oTypeToCheck.
	cStreamMetaType ()
virtual	~cStreamMetaType () override
Public Member Functions inherited from adtf::ucom::catwo::object< IStreamMetaType >
tResult	GetInterface (const char *i_strIID, void *&o_pInterface) override
	Query interfaces on an object.
tResult	GetInterface (const char *i_strIID, const void *&o_pInterface) const override
	Provides const correct interface querying.
void	Destroy () const override
	Switch from non-virtual destructor to virtual destructor.
tResult	GetInterface (const char *i_strIID, void *&o_pInterface) override
	Query interfaces on an object.
tResult	GetInterface (const char *i_strIID, const void *&o_pInterface) const override
	Provides const correct interface querying.
void	Destroy () const override
	Switch from non-virtual destructor to virtual destructor.
tResult	GetInterface (const char *i_strIID, void *&o_pInterface) override
	Query interfaces on an object.
tResult	GetInterface (const char *i_strIID, const void *&o_pInterface) const override
	Provides const correct interface querying.
void	Destroy () const override
	Switch from non-virtual destructor to virtual destructor.
Public Member Functions inherited from adtf::ucom::ant::IObject
	ADTF_IID (IObject, "object.ant.ucom.adtf.iid")

Protected Member Functions
tResult	SetMetaTypeName (const char *strTypeName)
Protected Member Functions inherited from adtf::ucom::ant::IObject
	~IObject ()=default
	Protected destructor --> Only the final implementation can be destroyed!

Protected Attributes
cString	m_strMetaTypeName
	MetaTypeName of the StreamMetaType (like "adtf/default")
adtf::ucom::object_ptr< adtf::base::IProperties >	m_pDefaultProperties
	Default properties.
adtf::ucom::object_ptr< IStreamMetaType >	m_pParentMetaType
	parent if any
tVersion	m_sVersion
	version

Detailed Description

Implements the default adtf::streaming::ant::IStreamMetaType interface.

Please have a look at Example Demo Custom Stream Type on how to implement your own stream types and stream meta types.

Constructor & Destructor Documentation

cStreamMetaType()

adtf::streaming::ant::cStreamMetaType::cStreamMetaType

(

)

Default CTOR

~cStreamMetaType()

virtual adtf::streaming::ant::cStreamMetaType::~cStreamMetaType ( )

overridevirtual

DTOR

Member Function Documentation

GetDefaultConfig()

tResult adtf::streaming::ant::cStreamMetaType::GetDefaultConfig ( adtf::ucom::ant::iobject_ptr< const adtf::base::IProperties > & pProperties ) const

override

Get the default configuration values for a Stream Type.

Parameters

[out]

pProperties

All properties of the default configuration

Returns

Standard error code

Return values

ERR_NOERROR

Everything went fine

GetMetaTypeName()

tResult adtf::streaming::ant::cStreamMetaType::GetMetaTypeName ( IString && strTypeName ) const

override

Gets the unique meta type name.

Returns

Standard error code

Parameters

[out]

strTypeName

The meta type name as string

Return values

ERR_NOERROR

Everything went fine

GetParent()

tResult adtf::streaming::ant::cStreamMetaType::GetParent ( adtf::ucom::ant::iobject_ptr< const IStreamMetaType > & pParent ) const

override

This GetParent function is deprecated.

Deprecated

This IStreamMetaType::GetParent function is not supported anymore!

Parameters

[out]

pParent

The parent Stream Type definition

Returns

Standard error code

Return values

ERR_NOERROR	Everything went fine
ERR_NOT_SUPPORTED	Is not supported anymore

Remarks

this method is deprecated.

GetVersion()

adtf::util::tVersion adtf::streaming::ant::cStreamMetaType::GetVersion ( ) const

override

Get version of a Stream Type.

Returns

Version of the Stream Type.

See also

adtf_util::tVersion

IsCompatible()

tResult adtf::streaming::ant::cStreamMetaType::IsCompatible ( const IStreamType & oTypeToCheck, const IStreamType & oTypeExpected ) const

override

Compares the oTypeExpected Stream Type with the oTypeToCheck.

This default implementation of IsCompatible will return ERR_NOERROR only if:

• IStreamMetaType::GetMetaTypeName of oTypeToCheck is equal to GetMetaTypeName of oTypeExpected
• IStreamMetaType::GetVersion of oTypeToCheck is equal to GetVersion of oTypeExpected

Parameters

[in]	oTypeToCheck	The incoming type to check.
[in]	oTypeExpected	The expected type which values are more significant.

Return values

ERR_NOERROR

types are compatible

SetMetaTypeName()

tResult adtf::streaming::ant::cStreamMetaType::SetMetaTypeName ( const char * strTypeName )

protected

Sets the unique type name.

Parameters

[in]

strTypeName

the unique type name for this meta type so set.

Returns

Standard Result Code

---

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

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