ADTF: cStreamMetaType

Searching...

No Matches

Implements the default IStreamMetaType interface. More...

#include <streamtype.h>

Inheritance diagram for cStreamMetaType:

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` - see Default Stream Meta Types in ADTF for a summary of implementations.

	cStreamMetaType ()
	Default CTOR.

virtual	~cStreamMetaType () override
	DTOR.

Public Member Functions inherited from 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 IObject
	ADTF_IID (IObject, "object.ant.ucom.adtf.iid")
	Marks the `IObject` to be castable with the `ucom_cast()`

Protected Member Functions
tResult	SetMetaTypeName (const char *strTypeName)
	Sets the unique type name.

Protected Member Functions inherited from 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

Private Member Functions
	cStreamMetaType (const cStreamMetaType &oFromStream)=delete

	cStreamMetaType (cStreamMetaType &&oSource)=delete

cStreamMetaType &	operator= (const cStreamMetaType &oStreamType)=delete

cStreamMetaType &	operator= (cStreamMetaType &&oStreamType)=delete

Detailed Description

Implements the default IStreamMetaType interface.

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

Definition at line 27 of file streamtype.h.

Member Function Documentation

◆ GetDefaultConfig()

tResult 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 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 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 GetVersion ( ) const

override

Get version of a Stream Type.

Returns: Version of the Stream Type.

See also: adtf_util::tVersion

◆ IsCompatible()

tResult IsCompatible	(	const IStreamType &	oTypeToCheck,
		const IStreamType &	oTypeExpected ) const

override

Compares the oTypeExpected Stream Type with the oTypeToCheck - see Default Stream Meta Types in ADTF for a summary of implementations.

This default implementation of IsCompatible will return ERR_NOERROR only if:

GetMetaTypeName of oTypeToCheck is equal to GetMetaTypeName of oTypeExpected
GetVersion of oTypeToCheck is equal to GetVersion of oTypeExpected

Remarks: For a complete definition of the delivered default types and the information of which Stream Type is compatible to another one then see Default Stream Meta Types in ADTF.

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

See also: Default Stream Meta Types in ADTF, AcceptType and IsCompatible implementations.

Referenced by stream_meta_type< MetaTypeStruct >::IsCompatible().

◆ SetMetaTypeName()

tResult 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

Referenced by stream_meta_type< MetaTypeStruct >::stream_meta_type().

Member Data Documentation

◆ m_pDefaultProperties

adtf::ucom::object_ptr<adtf::base::IProperties> m_pDefaultProperties

protected

Default properties.

Definition at line 41 of file streamtype.h.

Referenced by stream_meta_type< MetaTypeStruct >::stream_meta_type().

◆ m_pParentMetaType

adtf::ucom::object_ptr<IStreamMetaType> m_pParentMetaType

protected

parent if any

Definition at line 43 of file streamtype.h.

◆ m_strMetaTypeName

cString m_strMetaTypeName

protected

MetaTypeName of the StreamMetaType (like "adtf/default")

Definition at line 39 of file streamtype.h.

◆ m_sVersion

tVersion m_sVersion

protected

version

Definition at line 45 of file streamtype.h.

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Detailed Description

Member Function Documentation

◆ GetDefaultConfig()

◆ GetMetaTypeName()

◆ GetParent()

◆ GetVersion()

◆ IsCompatible()

◆ SetMetaTypeName()

Member Data Documentation

◆ m_pDefaultProperties

◆ m_pParentMetaType

◆ m_strMetaTypeName

◆ m_sVersion