adtf::streaming::hollow Namespace Reference

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

Classes
class	cFilterGraphClientPort
	Default implementation of a ClientPort. More...
class	cCamelionStreamMetaType
class	cCamelionStreamType
class	cRequestBroker
	This is the default implementation of IStreamingRequests used by requestable_writer. More...
class	writer_with_request_broker
	Template that will register a request broker (an implementation of IStreamingRequests) at the connected Sample Stream. More...
class	requestable_writer
	Writer that registers a request broker (cRequestBroker) at the connected sample stream. More...
class	ISample
	The ISample interface sets and retrieves properties on samples . More...
class	IStreamTypeHandler
	Interface for reacting synchrounously to stream type changes. More...
class	IStreamingRequest
	This interface is used to keep a reference to a request. More...
class	IStreamingRequests
	Interface for handling streaming requests. More...
class	IInternalBindingProxy
	Interface for accessing an internal Interface Binding Proxy of a sample stream. More...
struct	stream_meta_type_substreams
	Use cSubStreamTypes to create a Stream Type instance for this Stream Meta Type - see also Substreams. More...
class	cSubStreamTypes
	Helper class to create a stream type with multiple Substreams. More...

Functions
void	set_help_link (base::ant::IConfiguration &oConfig, const char *strUrl)
	Set the link to the corresponding help/documentation. More...
void	set_description (base::ant::IConfiguration &oConfig, const char *strItem, const char *strDescription)
	Set the description for a specified item of the graph object. More...
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. More...
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. More...
void	get_runner_objects (ant::IRuntimeBehaviour *pRuntimeBehaviour, ucom::ant::iobject_enum< ucom::ant::IObject > &oObjects)
	Get all runner objects object out of pRuntimeBehaviour. More...
void	get_child_objects (ant::INamedGraphObject &oObject, ucom::ant::iobject_enum< ucom::ant::IObject > &oObjects)
	Get all child objects of the given oObject. More...
void	get_graph_objects (ant::IGraph *pGraph, ucom::ant::iobject_enum< ucom::ant::IObject > &oObjects)
	Get all graph objects out of the pGraph. More...
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)
	Sets the substream id of a given sample. More...
void	set_sample_substream_id (const ucom::ant::iobject_ptr< ant::ISample > &pSample, uint32_t nSubStreamId)
	Sets the substream id of a given sample. More...

Detailed Description

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

Function Documentation

get_child_objects()

void 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

Definition at line 375 of file graph_utils.h.

References get_data_binding_objects(), get_graph_objects(), get_interface_binding_objects(), and get_runner_objects().

Referenced by get_graph_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

Definition at line 299 of file graph_utils.h.

References IDataBinding::GetPins(), and iobject_enum< INTERFACE_TYPE >::PushObject().

Referenced by get_child_objects().

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

Definition at line 357 of file graph_utils.h.

References get_child_objects(), IGraph::GetNamedGraphObjects(), and iobject_enum< INTERFACE_TYPE >::PushObject().

Referenced by get_child_objects().

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

Definition at line 316 of file graph_utils.h.

References IInterfaceBinding::GetBindingObjects(), and iobject_enum< INTERFACE_TYPE >::PushObject().

Referenced by get_child_objects().

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

Definition at line 333 of file graph_utils.h.

References IRuntimeBehaviour::GetRunners(), and iobject_enum< INTERFACE_TYPE >::PushObject().

Referenced by get_child_objects().

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.

Definition at line 230 of file sample.h.

References iobject_ptr_base< T >::Get().

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.

Referenced by output_sample_data< T >::SetSubStreamId().

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.

Definition at line 247 of file sample.h.

References iobject_ptr_base< T >::Get().