ADTF  3.15.1
adtf::streaming::devil Namespace Reference

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

Functions

tResult add_graph_object (ant::cGraph &oGraph, const util::cString &strCID, const util::cString &strName, const std::map< util::cString, util::cString > &oProperties, int32_t nOrderNumber, ucom::iobject_ptr< ucom::IObject > &pObject)
 Convenience functionality to create and add add graph object to a existing graph. More...
 
tResult add_graph_object (ant::cGraph &oGraph, const util::cString &strCID, const util::cString &strName, const std::map< util::cString, util::cString > &oProperties={}, int32_t nOrderNumber=0)
 Convenience functionality to add graph object to a existing graph. More...
 
tResult add_sample_stream (ant::cGraph &oGraph, const util::cString &strName, int32_t nOrderNumber, ucom::iobject_ptr< ucom::IObject > &pSampleStream)
 
tResult add_sample_stream (ant::cGraph &oGraph, const util::cString &strName, int32_t nOrderNumber=0)
 Adds a sample stream to the graph. More...
 
tResult add_binding_proxy (ant::cGraph &oGraph, const util::cString &strName, int32_t nOrderNumber, ucom::iobject_ptr< ucom::IObject > &pBindingProxy)
 adds a Binding Proxy to a graph and return the created proxy. More...
 
tResult add_binding_proxy (cGraph &oGraph, const util::cString &strName, int32_t nOrderNumber=0)
 adds a Binding Proxy to a graph. More...
 
tResult add_data_out_port (ant::cGraph &oGraph, const util::cString &strName, int32_t nOrderNumber, ucom::iobject_ptr< ucom::IObject > &pPort)
 adds an Out Port to a graph and return the created port. More...
 
tResult add_data_out_port (ant::cGraph &oGraph, const util::cString &strName, int32_t nOrderNumber=0)
 adds an Out Port to a graph. More...
 
tResult add_data_in_port (ant::cGraph &oGraph, const util::cString &strName, int32_t nOrderNumber, ucom::iobject_ptr< ucom::IObject > &pPort)
 adds an In Port to a graph and return the created port. More...
 
tResult add_data_in_port (ant::cGraph &oGraph, const util::cString &strName, int32_t nOrderNumber=0)
 adds an In Port to a graph. More...
 
tResult add_sample_stream_out_port (ant::cGraph &oGraph, const util::cString &strName, const util::cString &strPortID, int32_t nOrderNumber, ucom::iobject_ptr< ucom::IObject > &pPort)
 adds a Stream Out Port to a graph and return the created port. More...
 
tResult add_sample_stream_out_port (ant::cGraph &oGraph, const util::cString &strName, const util::cString &strPortID, int32_t nOrderNumber=0)
 adds a Stream Out Port to a graph. More...
 
tResult add_sample_stream_in_port (ant::cGraph &oGraph, const util::cString &strName, const util::cString &strPortID, int32_t nOrderNumber, ucom::iobject_ptr< ucom::IObject > &pPort)
 adds a Stream In Port to a graph and return the created port. More...
 
tResult add_sample_stream_in_port (ant::cGraph &oGraph, const util::cString &strName, const util::cString &strPortID, int32_t nOrderNumber=0)
 adds a Stream In Port to a graph and return the created port. More...
 

Detailed Description

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

Function Documentation

◆ add_binding_proxy() [1/2]

tResult adtf::streaming::devil::add_binding_proxy ( ant::cGraph oGraph,
const util::cString &  strName,
int32_t  nOrderNumber,
ucom::iobject_ptr< ucom::IObject > &  pBindingProxy 
)
inline

adds a Binding Proxy to a graph and return the created proxy.

Parameters
oGraphThe graph where to add the Binding Proxy to.
strNameName of the Binding Proxy within the graph
nOrderNumberThe order numer of the new Binding Proxy.
pBindingProxyReturn value for the instance of the Binding Proxy created.
Returns
tResult

Definition at line 117 of file graph_utils.h.

References cGraph::AddNamedGraphObject(), iobject_ptr_base< T >::Reset(), and RETURN_IF_FAILED.

Referenced by add_binding_proxy().

◆ add_binding_proxy() [2/2]

tResult adtf::streaming::devil::add_binding_proxy ( cGraph oGraph,
const util::cString &  strName,
int32_t  nOrderNumber = 0 
)
inline

adds a Binding Proxy to a graph.

Parameters
oGraphThe graph where to add the Binding Proxy to.
strNameName of the Binding Proxy within the graph
nOrderNumberThe order numer of the new Binding Proxy.
Returns
tResult

Definition at line 134 of file graph_utils.h.

References add_binding_proxy().

◆ add_data_in_port() [1/2]

tResult adtf::streaming::devil::add_data_in_port ( ant::cGraph oGraph,
const util::cString &  strName,
int32_t  nOrderNumber,
ucom::iobject_ptr< ucom::IObject > &  pPort 
)
inline

adds an In Port to a graph and return the created port.

Parameters
oGraphThe graph where to add the In Port to.
strNameName of the In Port within the graph
nOrderNumberThe order numer of the new In Port.
pPortReturn value for the instance of the port created.
Returns
tResult

Definition at line 184 of file graph_utils.h.

References cGraph::AddNamedGraphObject(), iobject_ptr_base< T >::Reset(), and RETURN_IF_FAILED.

Referenced by add_data_in_port().

◆ add_data_in_port() [2/2]

tResult adtf::streaming::devil::add_data_in_port ( ant::cGraph oGraph,
const util::cString &  strName,
int32_t  nOrderNumber = 0 
)
inline

adds an In Port to a graph.

Parameters
oGraphThe graph where to add the In Port to.
strNameName of the In Port within the graph
nOrderNumberThe order numer of the new In Port.
Returns
tResult

Definition at line 202 of file graph_utils.h.

References add_data_in_port().

◆ add_data_out_port() [1/2]

tResult adtf::streaming::devil::add_data_out_port ( ant::cGraph oGraph,
const util::cString &  strName,
int32_t  nOrderNumber,
ucom::iobject_ptr< ucom::IObject > &  pPort 
)
inline

adds an Out Port to a graph and return the created port.

Parameters
oGraphThe graph where to add the Out Port to.
strNameName of the Out Port within the graph.
nOrderNumberThe order numer of the new Out Port.
pPortReturn value for the instance of the port created.
Returns
tResult

Definition at line 149 of file graph_utils.h.

References cGraph::AddNamedGraphObject(), iobject_ptr_base< T >::Reset(), and RETURN_IF_FAILED.

Referenced by add_data_out_port().

◆ add_data_out_port() [2/2]

tResult adtf::streaming::devil::add_data_out_port ( ant::cGraph oGraph,
const util::cString &  strName,
int32_t  nOrderNumber = 0 
)
inline

adds an Out Port to a graph.

Parameters
oGraphThe graph where to add the Out Port to.
strNameName of the Out Port within the graph.
nOrderNumberThe order numer of the new Out Port.
Returns
tResult

Definition at line 167 of file graph_utils.h.

References add_data_out_port().

◆ add_graph_object() [1/2]

tResult adtf::streaming::devil::add_graph_object ( ant::cGraph oGraph,
const util::cString &  strCID,
const util::cString &  strName,
const std::map< util::cString, util::cString > &  oProperties,
int32_t  nOrderNumber,
ucom::iobject_ptr< ucom::IObject > &  pObject 
)
inline

Convenience functionality to create and add add graph object to a existing graph.

Parameters
oGraphThe Graph where to add the object.
strCIDThe class interface name of class to create the object.
strNameThe name of the object within the graph.
oPropertiesThe properties to set.
nOrderNumberthe order number of the object
pObjectReturn value for the instance of the object created.
Returns
tResult

Definition at line 39 of file graph_utils.h.

References _runtime, cGraph::AddNamedGraphObject(), IRuntime::CreateInstance(), object_ptr< T >::Get(), iobject_ptr_base< T >::Reset(), and RETURN_IF_FAILED.

◆ add_graph_object() [2/2]

tResult adtf::streaming::devil::add_graph_object ( ant::cGraph oGraph,
const util::cString &  strCID,
const util::cString &  strName,
const std::map< util::cString, util::cString > &  oProperties = {},
int32_t  nOrderNumber = 0 
)
inline

Convenience functionality to add graph object to a existing graph.

Parameters
oGraphThe Graph where to create and add the object.
strCIDThe class interface name of class to create the object.
strNameThe name of the object within the graph.
oPropertiesThe properties to set.
nOrderNumberthe order number of the object
Returns
tResult

Definition at line 72 of file graph_utils.h.

◆ add_sample_stream()

tResult adtf::streaming::devil::add_sample_stream ( ant::cGraph oGraph,
const util::cString &  strName,
int32_t  nOrderNumber = 0 
)
inline

Adds a sample stream to the graph.

Parameters
oGraphThe graph where to add the Sample Stream to.
strNameName of the Sample Stream
nOrderNumberthe order numer of the new Sample Stream.
Returns
tResult

Definition at line 100 of file graph_utils.h.

◆ add_sample_stream_in_port() [1/2]

tResult adtf::streaming::devil::add_sample_stream_in_port ( ant::cGraph oGraph,
const util::cString &  strName,
const util::cString &  strPortID,
int32_t  nOrderNumber,
ucom::iobject_ptr< ucom::IObject > &  pPort 
)
inline

adds a Stream In Port to a graph and return the created port.

Parameters
oGraphThe graph where to add the Stream In Port to.
strNameName of the Stream In Port within the graph
strPortIDPort ID as it appears in the streaming graph
nOrderNumberThe order numer of the new Stream In Port.
pPortReturn value for the instance of the port created.
Returns
tResult

Definition at line 259 of file graph_utils.h.

References cGraph::AddNamedGraphObject(), iobject_ptr_base< T >::Reset(), and RETURN_IF_FAILED.

Referenced by add_sample_stream_in_port().

◆ add_sample_stream_in_port() [2/2]

tResult adtf::streaming::devil::add_sample_stream_in_port ( ant::cGraph oGraph,
const util::cString &  strName,
const util::cString &  strPortID,
int32_t  nOrderNumber = 0 
)
inline

adds a Stream In Port to a graph and return the created port.

Parameters
oGraphThe graph where to add the Stream In Port to.
strNameName of the Stream In Port within the graph
strPortIDPort ID as it appears in the streaming graph
nOrderNumberThe order numer of the new Stream In Port.
Returns
tResult

Definition at line 279 of file graph_utils.h.

References add_sample_stream_in_port().

◆ add_sample_stream_out_port() [1/2]

tResult adtf::streaming::devil::add_sample_stream_out_port ( ant::cGraph oGraph,
const util::cString &  strName,
const util::cString &  strPortID,
int32_t  nOrderNumber,
ucom::iobject_ptr< ucom::IObject > &  pPort 
)
inline

adds a Stream Out Port to a graph and return the created port.

Parameters
oGraphThe graph where to add the Stream Out Port to.
strNameName of the Stream Out Port within the graph
strPortIDPort ID As it appears in the streaming graph
nOrderNumberThe order numer of the new Stream Out Port.
pPortReturn value for the instance of the port created.
Returns
tResult

Definition at line 220 of file graph_utils.h.

References cGraph::AddNamedGraphObject(), iobject_ptr_base< T >::Reset(), and RETURN_IF_FAILED.

Referenced by add_sample_stream_out_port().

◆ add_sample_stream_out_port() [2/2]

tResult adtf::streaming::devil::add_sample_stream_out_port ( ant::cGraph oGraph,
const util::cString &  strName,
const util::cString &  strPortID,
int32_t  nOrderNumber = 0 
)
inline

adds a Stream Out Port to a graph.

Parameters
oGraphThe graph where to add the Stream Out Port to.
strNameName of the Stream Out Port within the graph
strPortIDPort ID as it appears in the streaming graph
nOrderNumberThe order numer of the new Stream Out Port.
Returns
tResult

Definition at line 240 of file graph_utils.h.

References add_sample_stream_out_port().