ADTF  3.13.2
cStreamMetaType

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

Inheritance diagram for cStreamMetaType:
[legend]

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 tChar *i_strIID, tVoid *&o_pInterface) override
 Query interfaces on an object. More...
 
tResult GetInterface (const tChar *i_strIID, const tVoid *&o_pInterface) const override
 Provides const correct interface querying. More...
 
tVoid 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 tChar *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::IPropertiesm_pDefaultProperties
 Default properties.
 
adtf::ucom::object_ptr< IStreamMetaTypem_pParentMetaType
 parent if any
 
tVersion m_sVersion
 version
 

Private Member Functions

 cStreamMetaType (const cStreamMetaType &oFromStream)=delete
 
 cStreamMetaType (cStreamMetaType &&oSource)=delete
 
cStreamMetaTypeoperator= (const cStreamMetaType &oStreamType)=delete
 
cStreamMetaTypeoperator= (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]pPropertiesAll properties of the default configuration
Returns
Standard error code
Return values
ERR_NOERROREverything went fine

◆ GetMetaTypeName()

tResult GetMetaTypeName ( IString &&  strTypeName) const
override

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()

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]pParentThe parent Stream Type definition
Returns
Standard error code
Return values
ERR_NOERROREverything went fine
ERR_NOT_SUPPORTEDIs 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:

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]oTypeToCheckThe incoming type to check.
[in]oTypeExpectedThe expected type which values are more significant.
Return values
ERR_NOERRORtypes 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 tChar strTypeName)
protected

Sets the unique type name.

Parameters
[in]strTypeNamethe unique type name for this meta type so set.
Returns
Standard Result Code

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


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