ADTF  3.13.2
IStreamMetaTypeabstract

Defines access methods for a Stream Meta Type - see also Stream Type and Stream Meta Type for more information. More...

Inheritance diagram for IStreamMetaType:
[legend]

Public Member Functions

 ADTF_IID (IStreamMetaType, "streamtypedef.ant.streaming.adtf.iid")
 Interface ID for the Stream Typedef interface.
 
virtual tResult GetMetaTypeName (base::ant::IString &&strTypeName) const =0
 Gets the unique meta type name. More...
 
virtual adtf::util::tVersion GetVersion () const =0
 Get version of a Stream Type. More...
 
virtual tResult GetDefaultConfig (ucom::ant::iobject_ptr< const base::ant::IProperties > &pProperties) const =0
 Get the default configuration values for a Stream Type. More...
 
virtual tResult GetParent (ucom::ant::iobject_ptr< const IStreamMetaType > &pParent) const =0
 This GetParent function is deprecated. More...
 
virtual tResult IsCompatible (const IStreamType &oTypeToCheck, const IStreamType &oExpectedType) const =0
 Compares the Stream Type oTypeToCheck based on this meta type - see Default Stream Meta Types in ADTF for a summary of implementations. 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

 ~IStreamMetaType ()=default
 not destructable
 
- Protected Member Functions inherited from IObject
 ~IObject ()=default
 Protected destructor –> Use implemented Destroy() instead of delete!
 

Detailed Description

Defines access methods for a Stream Meta Type - see also Stream Type and Stream Meta Type for more information.

The Stream Meta Type provides the user with all necessary information of a Stream Type. These information cover:

See also
Stream Type and Stream Meta Type

Definition at line 36 of file streamtype_intf.h.

Member Function Documentation

◆ GetDefaultConfig()

virtual tResult GetDefaultConfig ( ucom::ant::iobject_ptr< const base::ant::IProperties > &  pProperties) const
pure virtual

Get the default configuration values for a Stream Type.

Parameters
[out]pPropertiesAll properties of the default configuration
Returns
Standard error code
Return values
ERR_NOERROREverything went fine

◆ GetMetaTypeName()

virtual tResult GetMetaTypeName ( base::ant::IString &&  strTypeName) const
pure virtual

Gets the unique meta type name.

Returns
Standard error code
Parameters
[out]strTypeNameThe meta type name as string
Return values
ERR_NOERROREverything went fine

◆ GetParent()

virtual tResult GetParent ( ucom::ant::iobject_ptr< const IStreamMetaType > &  pParent) const
pure virtual

This GetParent function is deprecated.

Deprecated:
This IStreamMetaType::GetParent function is not supported anymore!
Parameters
[out]pParentThe parent Stream Type definition
Returns
Standard error code
Return values
ERR_NOERROREverything went fine
ERR_NOT_SUPPORTEDIs not supported anymore

◆ GetVersion()

virtual adtf::util::tVersion GetVersion ( ) const
pure virtual

Get version of a Stream Type.

Returns
Version of the Stream Type.
See also
adtf_util::tVersion

◆ IsCompatible()

virtual tResult IsCompatible ( const IStreamType oTypeToCheck,
const IStreamType oExpectedType 
) const
pure virtual

Compares the Stream Type oTypeToCheck based on this meta type - see Default Stream Meta Types in ADTF for a summary of implementations.

It alway depends on the concete implementation what to check. For a complete overview of the default types and the information of which Stream Type is compatible to another one then see Default Stream Meta Types in ADTF.

Parameters
[in]oTypeToCheckThe incoming type to check.
[in]oExpectedTypeThe base type which
Return values
ERR_NOERRORtypes are compatible
See also
Default Stream Meta Types in ADTF

Copyright © Audi Electronics Venture GmbH. All rights reserved. (Generated on Tue Nov 16 2021 by doxygen 1.8.14)