adtf::streaming::ant::cStreamType Class Reference

#include <streamtype.h>

Inherits adtf::ucom::catwo::object< IStreamType >.

Inherited by adtf::streaming::flash::stream_type< StreamMetaType >, adtf::streaming::penguin::stream_type_anonymous< T >, adtf::streaming::penguin::stream_type_audio< T >, adtf::streaming::penguin::stream_type_image< T >, adtf::streaming::penguin::stream_type_plain< T< ValueType, szArraySize > >, adtf::streaming::penguin::stream_type_string< std::string >, adtf::streaming::penguin::stream_type_string< std::u16string >, and adtf::streaming::penguin::stream_type_string< std::wstring >.

Public Member Functions
	cStreamType ()
template<typename MetaType>
	cStreamType (const MetaType &)
	cStreamType (const IStreamType &pType)
virtual	~cStreamType ()
tTimeStamp	GetTime () const
tResult	SetTime (tTimeStamp oTimeStamp)
tResult	GetMetaTypeName (base::ant::IString &&strTypeName) const override
	Get the meta type name of this instance.
adtf::util::tVersion	GetVersion () const override
	Get version of this instance of the StreamMetaType.
tResult	GetConfig (adtf::ucom::iobject_ptr< base::ant::IProperties > &pProperties) override
	Get all properties of a Stream Type (read/write)
tResult	GetConfig (adtf::ucom::iobject_ptr< const base::ant::IProperties > &pProperties) const override
	Get all properties of a Stream Type (read/write)
tResult	GetMetaType (adtf::ucom::iobject_ptr< const IStreamMetaType > &pMetaType) const override
	Get the Stream Meta Type definition of the Stream Type.
Public Member Functions inherited from adtf::ucom::catwo::object< IStreamType >
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 adtf::ucom::ant::IObject
	ADTF_IID (IObject, "object.ant.ucom.adtf.iid")

Protected Member Functions
	cStreamType (const cStreamType &oType)=delete
	hide copy CTOR
cStreamType &	operator= (const cStreamType &oType)=delete
	hide copy operator
	cStreamType (cStreamType &&oType)=delete
	hide move CTOR
cStreamType &	operator= (cStreamType &&oType)=delete
	hide move operator
Protected Member Functions inherited from adtf::ucom::ant::IObject
	~IObject ()=default
	Protected destructor --> Only the final implementation can be destroyed!

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 Example Demo Custom Stream Type on how to implement your own stream types and stream meta types.

Constructor & Destructor Documentation

cStreamType() [1/3]

adtf::streaming::ant::cStreamType::cStreamType

(

)

Default CTOR

cStreamType() [2/3]

template<typename MetaType>

adtf::streaming::ant::cStreamType::cStreamType ( const MetaType & )

inline

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

Template Parameters

MetaType

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

cStreamType() [3/3]

adtf::streaming::ant::cStreamType::cStreamType

(

const IStreamType &

pType

)

Copy CTOR will create fully deep copy of given pType

Parameters

[in]

pType

Interface reference of the IStreamType that will be copied.

~cStreamType()

virtual adtf::streaming::ant::cStreamType::~cStreamType ( )

virtual

DTOR

Member Function Documentation

GetConfig() [1/2]

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

override

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

Parameters

[out]

pProperties

All properties of a Stream Type (can be modified)

Returns

Standard error code

Return values

ERR_NOERROR

Everything went fine

GetConfig() [2/2]

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

override

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

Parameters

[out]

pProperties

All properties of a Stream Type (can be modified)

Returns

Standard error code

Return values

ERR_NOERROR

Everything went fine

GetMetaType()

tResult adtf::streaming::ant::cStreamType::GetMetaType ( adtf::ucom::iobject_ptr< const IStreamMetaType > & pMetaType ) const

override

Get the Stream Meta Type definition of the Stream Type.

Parameters

[out]

pMetaType

The Stream Meta Type definition of this Stream Type

Returns

Standard error code

Return values

ERR_NOERROR

Everything went fine

GetMetaTypeName()

tResult adtf::streaming::ant::cStreamType::GetMetaTypeName ( base::ant::IString && strTypeName ) const

override

Get the meta type name of this instance.

Returns

Standard error code

Parameters

[out]

strTypeName

The meta type name as string

Return values

ERR_NOERROR

Everything went fine

GetVersion()

adtf::util::tVersion adtf::streaming::ant::cStreamType::GetVersion ( ) const

override

Get version of this instance of the StreamMetaType.

Returns

Version of the StreamMetaType instantiated.

See also

adtf_util::tVersion

---

The documentation for this class was generated from the following file:

• src/libraries/streaming3/include/adtfstreaming3/streamtype.h