cStreamTypeHelper

Helper class that wraps different objects into an adtf::streaming::ant::IStreamType. More...

Public Member Functions
	cStreamTypeHelper (std::nullptr_t pNull)
	Initialize with an empty stream type. More...
	cStreamTypeHelper (const ucom::ant::iobject_ptr< streaming::ant::IStreamType > &pExistingType)
	Initialize the helper with an existing IStreamType pointer. More...
	cStreamTypeHelper (const ucom::ant::iobject_ptr< const streaming::ant::IStreamType > &pExistingType)
	Initialize the helper with an existing const IStreamType pointer. More...
	cStreamTypeHelper (const streaming::ant::IStreamType &oExistingType)
	Initialize the helper with an existing IStreamType reference. More...
	cStreamTypeHelper (const streaming::hollow::cSubStreamTypes &oSubStreams)
	Initialize the helper with a Substream helper. More...
template<typename MetaType >
	cStreamTypeHelper (const MetaType &oMetaType, const std::enable_if_t< streaming::flash::is_stream_meta_type< MetaType >::value > *=nullptr)
	Initializes the helper with a stream meta type. More...
template<typename Struct >
	cStreamTypeHelper (const mediadescription::osborn::description< Struct > &)
	Initializes the helper with a generated media description. More...
	cStreamTypeHelper (const ddl::DDStructure &oTypeDefinition)
	Initialize the helper with a structure definition. More...
template<typename StructType >
	cStreamTypeHelper (const mediadescription::osborn::structure< StructType > &oGeneratorStructure)
	Initializes the helper with a type reflection generated media description. More...
	cStreamTypeHelper (const cStreamTypeHelper &)=default
	cStreamTypeHelper (cStreamTypeHelper &&)=default
cStreamTypeHelper &	operator= (const cStreamTypeHelper &)=default
cStreamTypeHelper &	operator= (cStreamTypeHelper &&)=default
ucom::ant::object_ptr< const streaming::ant::IStreamType >	GetStreamType () const

Private Attributes
ucom::ant::object_ptr< const streaming::ant::IStreamType >	m_pStreamType

Detailed Description

Helper class that wraps different objects into an adtf::streaming::ant::IStreamType.

This used by cGraphObject::CreateInputPin, cGraphObject::CreateInputPinWithCallback and cGraphObject::CreateOutputPin to simplify their use and prevent the need for more overloads for the different kind of objects defining the stream type.

Definition at line 29 of file stream_type_helper.h.

Constructor & Destructor Documentation

cStreamTypeHelper() [1/9]

cStreamTypeHelper

(

std::nullptr_t

pNull

)

Initialize with an empty stream type.

Parameters

[in]

pNull

A nullptr.

cStreamTypeHelper() [2/9]

cStreamTypeHelper

(

const ucom::ant::iobject_ptr< streaming::ant::IStreamType > &

pExistingType

)

Initialize the helper with an existing IStreamType pointer.

Parameters

[in]

pExistingType

The existing stream type. If the pointer is empty, an adtf::streaming::ant::stream_meta_type_anonymous will be set.

cStreamTypeHelper() [3/9]

cStreamTypeHelper

(

const ucom::ant::iobject_ptr< const streaming::ant::IStreamType > &

pExistingType

)

Initialize the helper with an existing const IStreamType pointer.

This is required to allow an implicit conversion.

Parameters

[in]

pExistingType

The existing stream type. If the pointer is empty, an adtf::streaming::ant::stream_meta_type_anonymous will be set.

cStreamTypeHelper() [4/9]

cStreamTypeHelper

(

const streaming::ant::IStreamType &

oExistingType

)

Initialize the helper with an existing IStreamType reference.

Parameters

[in]

oExistingType

cStreamTypeHelper() [5/9]

cStreamTypeHelper

(

const streaming::hollow::cSubStreamTypes &

oSubStreams

)

Initialize the helper with a Substream helper.

Parameters

[in]

oSubStreams

The substream helper.

cStreamTypeHelper() [6/9]

cStreamTypeHelper ( const MetaType &  oMetaType, const std::enable_if_t< streaming::flash::is_stream_meta_type< MetaType >::value > *  = nullptr  )

inline

Initializes the helper with a stream meta type.

This will create a stream type of the given stream meta type (with its property default values).

Template Parameters

MetaType

The meta type.

Parameters

[in]

oMetaType

A meta type object.

Definition at line 91 of file stream_type_helper.h.

cStreamTypeHelper() [7/9]

cStreamTypeHelper ( const mediadescription::osborn::description< Struct > &  )

inline

Initializes the helper with a generated media description.

Parameters

[in]

oDescription

The generated structure media description.

Definition at line 102 of file stream_type_helper.h.

cStreamTypeHelper() [8/9]

cStreamTypeHelper

(

const ddl::DDStructure &

oTypeDefinition

)

Initialize the helper with a structure definition.

This will create an "adtf/default" stream type with the corresponding media description set.

Parameters

[in]

oTypeDefinition

The structure definition.

cStreamTypeHelper() [9/9]

cStreamTypeHelper ( const mediadescription::osborn::structure< StructType > &  oGeneratorStructure )

inline

Initializes the helper with a type reflection generated media description.

Parameters

[in]

oGeneratorStructure

The type reflection generated media description structure.

Definition at line 119 of file stream_type_helper.h.

Member Function Documentation

GetStreamType()

ucom::ant::object_ptr<const streaming::ant::IStreamType> GetStreamType

(

)

const

Returns

The stream type that has been set or generated from the constructor arguments.

Referenced by cGraphObject::CreateReader(), and cGraphObject::CreateWriter().