adtf::streaming::hollow Namespace Reference

Namespace for all functionality of the ADTF Streaming SDK provided since v3.7. More...

Classes
class	cCamelionStreamMetaType
class	cCamelionStreamType
class	cFilterGraphClientPort
class	cRequestBroker
class	cSubStreamTypes
class	IInternalBindingProxy
class	ISample
class	IStreamingRequest
class	IStreamingRequests
class	IStreamTypeHandler
class	requestable_writer
struct	stream_meta_type_substreams
	Use cSubStreamTypes to create a Stream Type instance for this Stream Meta Type. More...
class	writer_with_request_broker

Functions
void	set_help_link (base::ant::IConfiguration &oConfig, const char *strUrl)
void	set_description (base::ant::IConfiguration &oConfig, const char *strItem, const char *strDescription)
void	get_data_binding_objects (ant::IDataBinding *pDataBinding, ucom::ant::iobject_enum< adtf::ucom::ant::IObject > &oObjects)
	Get all the data binding objects out of pDataBinding.
void	get_interface_binding_objects (ant::IInterfaceBinding *pInterfaceBinding, ucom::ant::iobject_enum< adtf::ucom::ant::IObject > &oObjects)
	Get all the interface binding objects out of pInterfaceBinding.
void	get_runner_objects (ant::IRuntimeBehaviour *pRuntimeBehaviour, ucom::ant::iobject_enum< ucom::ant::IObject > &oObjects)
	Get all runner objects object out of pRuntimeBehaviour.
void	get_child_objects (ant::INamedGraphObject &oObject, ucom::ant::iobject_enum< ucom::ant::IObject > &oObjects)
	Get all child objects of the given oObject.
void	get_graph_objects (ant::IGraph *pGraph, ucom::ant::iobject_enum< ucom::ant::IObject > &oObjects)
	Get all graph objects out of the pGraph.
uint32_t	get_sample_substream_id (const ant::ISample &oSample)
uint32_t	get_sample_substream_id (const ucom::ant::iobject_ptr< const ant::ISample > &pSample)
void	set_sample_substream_id (ant::ISample &oSample, uint32_t nSubStreamId)
void	set_sample_substream_id (const ucom::ant::iobject_ptr< ant::ISample > &pSample, uint32_t nSubStreamId)

Detailed Description

Namespace for all functionality of the ADTF Streaming SDK provided since v3.7.

Function Documentation

get_child_objects()

void adtf::streaming::hollow::get_child_objects ( ant::INamedGraphObject & oObject, ucom::ant::iobject_enum< ucom::ant::IObject > & oObjects )

inline

Get all child objects of the given oObject.

Parameters

oObject	the object has childrens
oObjects	all child objects

get_data_binding_objects()

void adtf::streaming::hollow::get_data_binding_objects ( ant::IDataBinding * pDataBinding, ucom::ant::iobject_enum< adtf::ucom::ant::IObject > & oObjects )

inline

Get all the data binding objects out of pDataBinding.

Parameters

pDataBinding	The Data binding object to retrieve the binding objects from
oObjects	list of objects returned

get_graph_objects()

void adtf::streaming::hollow::get_graph_objects ( ant::IGraph * pGraph, ucom::ant::iobject_enum< ucom::ant::IObject > & oObjects )

inline

Get all graph objects out of the pGraph.

Parameters

pGraph	the Graph where to get the grpah objects from
oObjects	the list of graph objects to return

get_interface_binding_objects()

void adtf::streaming::hollow::get_interface_binding_objects ( ant::IInterfaceBinding * pInterfaceBinding, ucom::ant::iobject_enum< adtf::ucom::ant::IObject > & oObjects )

inline

Get all the interface binding objects out of pInterfaceBinding.

Parameters

pInterfaceBinding	The Interface binding object to retrieve the binding objects from
oObjects	list of objects returned

get_runner_objects()

void adtf::streaming::hollow::get_runner_objects ( ant::IRuntimeBehaviour * pRuntimeBehaviour, ucom::ant::iobject_enum< ucom::ant::IObject > & oObjects )

inline

Get all runner objects object out of pRuntimeBehaviour.

Parameters

pRuntimeBehaviour	the runtime behaviour
oObjects	the list of runner objects returned

get_sample_substream_id() [1/2]

uint32_t adtf::streaming::hollow::get_sample_substream_id

(

const ant::ISample &

oSample

)

Parameters

[in]

oSample

The sample to retrieve the substream id from.

Returns

the substream id of the given sample.

get_sample_substream_id() [2/2]

uint32_t adtf::streaming::hollow::get_sample_substream_id ( const ucom::ant::iobject_ptr< const ant::ISample > & pSample )

inline

Parameters

[in]

pSample

The sample to retrieve the substream id from.

Returns

the substream id of the given sample.

set_description()

void adtf::streaming::hollow::set_description	(	base::ant::IConfiguration &	oConfig,
		const char *	strItem,
		const char *	strDescription )

Set the description for a specified item of the graph object

Parameters

[in]	oConfig	The configuration instance where the description will be stored
[in]	strItem	The item name of the object (i.e. name of Pin, Binding Proxy, Runner)
[in]	strDescription	The description for the item

set_help_link()

void adtf::streaming::hollow::set_help_link	(	base::ant::IConfiguration &	oConfig,
		const char *	strUrl )

Set the link to the corresponding help/documentation

Parameters

[in]	oConfig	The configuration instance where the help link will be stored
[in]	strUrl	The url to the help document (i.e. an HTML file).

set_sample_substream_id() [1/2]

void adtf::streaming::hollow::set_sample_substream_id	(	ant::ISample &	oSample,
		uint32_t	nSubStreamId )

Sets the substream id of a given sample.

Parameters

[in]	oSample	The sample that should be updated.
[in]	nSubStreamId	The substream id to be set.

set_sample_substream_id() [2/2]

void adtf::streaming::hollow::set_sample_substream_id ( const ucom::ant::iobject_ptr< ant::ISample > & pSample, uint32_t nSubStreamId )

inline

Sets the substream id of a given sample.

Parameters

[in]	pSample	The sample that should be updated.
[in]	nSubStreamId	The substream id to be set.