ADTF  3.13.2
cStreamType

Default StreamType implementation. More...

Inheritance diagram for cStreamType:
[legend]

Public Member Functions

 cStreamType ()
 Default CTOR.
 
template<typename MetaType >
 cStreamType (const MetaType &)
 Convenience CTOR will create an Instance of given Stream Meta Type oTypeDefintion and sets the default properties. More...
 
 cStreamType (const IStreamType &pType)
 Copy CTOR will create fully deep copy of given pType. More...
 
virtual ~cStreamType ()
 DTOR.
 
tTimeStamp GetTime () const
 
tResult SetTime (tTimeStamp oTimeStamp)
 
tResult GetMetaTypeName (base::ant::IString &&strTypeName) const override
 Get the meta type name of this instance. More...
 
adtf::util::tVersion GetVersion () const override
 Get version of this instance of the StreamMetaType. More...
 
tResult GetConfig (adtf::ucom::iobject_ptr< base::ant::IProperties > &pProperties) override
 Get all properties of a Stream Type (read/write) More...
 
tResult GetConfig (adtf::ucom::iobject_ptr< const base::ant::IProperties > &pProperties) const override
 Get all properties of a Stream Type (read/write) More...
 
tResult GetMetaType (adtf::ucom::iobject_ptr< const IStreamMetaType > &pMetaType) const override
 Get the Stream Meta Type definition of the Stream Type. More...
 
- Public Member Functions inherited from object< IStreamType >
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

 cStreamType (const cStreamType &oType)=delete
 hide copy CTOR
 
cStreamTypeoperator= (const cStreamType &oType)=delete
 hide copy operator
 
 cStreamType (cStreamType &&oType)=delete
 hide move CTOR
 
cStreamTypeoperator= (cStreamType &&oType)=delete
 hide move operator
 
- Protected Member Functions inherited from IObject
 ~IObject ()=default
 Protected destructor –> Use implemented Destroy() instead of delete!
 

Private Member Functions

tResult InitPropertiesFromStreamTypeDefintion (base::ant::IProperties &oWhereToSet, const IStreamMetaType &oStreamTypeDefintion)
 

Private Attributes

adtf::ucom::object_ptr< base::ant::IPropertiesm_pProperties
 Properties of this instance.
 
adtf::ucom::object_ptr< const IStreamMetaTypem_pStreamMetaType
 The StreamMetaType Definiton.
 
tTimeStamp m_pTimeStamp = -1
 

Detailed Description

Default StreamType implementation.

This StreamType is an instance of an StreamMetaType Definition (see IStreamMetaType)

IStreamMetaType will define which properties are valid and which default values are set. The cStreamtype will COPY this definitions, all values are adjustable!

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 281 of file streamtype.h.

Constructor & Destructor Documentation

◆ cStreamType() [1/2]

cStreamType ( const MetaType &  )
inline

Convenience CTOR will create an Instance of given Stream Meta Type oTypeDefintion and sets the default properties.

Template Parameters
MetaTypeThe implemementation class of a Stream Meta Type. This class must implement some constrains defined by the generator class stream_meta_type.

Definition at line 303 of file streamtype.h.

References cStreamType::m_pProperties, and cStreamType::m_pStreamMetaType.

◆ cStreamType() [2/2]

cStreamType ( const IStreamType pType)

Copy CTOR will create fully deep copy of given pType.

Parameters
[in]pTypeInterface reference of the IStreamType that will be copied.

Member Function Documentation

◆ GetConfig() [1/2]

tResult GetConfig ( adtf::ucom::iobject_ptr< base::ant::IProperties > &  pProperties)
override

Get all properties of a Stream Type (read/write)

Parameters
[out]pPropertiesAll properties of a Stream Type (can be modified)
Returns
Standard error code
Return values
ERR_NOERROREverything went fine

◆ GetConfig() [2/2]

tResult GetConfig ( adtf::ucom::iobject_ptr< const base::ant::IProperties > &  pProperties) const
override

Get all properties of a Stream Type (read/write)

Parameters
[out]pPropertiesAll properties of a Stream Type (can be modified)
Returns
Standard error code
Return values
ERR_NOERROREverything went fine

◆ GetMetaType()

tResult GetMetaType ( adtf::ucom::iobject_ptr< const IStreamMetaType > &  pMetaType) const
override

Get the Stream Meta Type definition of the Stream Type.

Parameters
[out]pMetaTypeThe Stream Meta Type definition of this Stream Type
Returns
Standard error code
Return values
ERR_NOERROREverything went fine

◆ GetMetaTypeName()

tResult GetMetaTypeName ( base::ant::IString &&  strTypeName) const
override

Get the meta type name of this instance.

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

◆ GetVersion()

adtf::util::tVersion GetVersion ( ) const
override

Get version of this instance of the StreamMetaType.

Returns
Version of the StreamMetaType instantiated.
See also
adtf_util::tVersion

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