cStreamMetaType

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

Inheritance diagram for cStreamMetaType:

Public Member Functions
tResult	GetMetaTypeName (IString &&strTypeName) const override
	Gets the unique meta type name. More...
adtf::util::tVersion	GetVersion () const override
	Get version of a Stream Type. More...
tResult	GetDefaultConfig (adtf::ucom::ant::iobject_ptr< const adtf::base::IProperties > &pProperties) const override
	Get the default configuration values for a Stream Type. More...
tResult	GetParent (adtf::ucom::ant::iobject_ptr< const IStreamMetaType > &pParent) const override
	This GetParent function is deprecated. More...
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. More...
	cStreamMetaType ()
	Default CTOR.
virtual	~cStreamMetaType ()=default
	DTOR.
Public Member Functions inherited from object< IStreamMetaType >
tResult	GetInterface (const char *i_strIID, void *&o_pInterface) override
	Query interfaces on an object. More...
tResult	GetInterface (const char *i_strIID, const void *&o_pInterface) const override
	Provides const correct interface querying. More...
void	Destroy () const override
	Destruct and deallocate instantiations of type IObject. More...
Public Member Functions inherited from IObject
	ADTF_IID (IObject, "object.ant.ucom.adtf.iid")
	Marks the IObject to be castable with the ucom_cast() More...

Protected Member Functions
tResult	SetMetaTypeName (const char *strTypeName)
	Sets the unique type name. More...
Protected Member Functions inherited from IObject
	~IObject ()=default
	Protected destructor --> Use implemented Destroy() instead of delete!

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 adtf::streaming::ant::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:

• IStreamMetaType::GetMetaTypeName of oTypeToCheck is equal to GetMetaTypeName of oTypeExpected
• IStreamMetaType::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().