ADTF  3.14.3
adtf::streaming::giant Namespace Reference

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

Functions

void set_description (base::ant::IConfiguration &oConfig, const char *strDescription)
 Sets description information. More...
 
void set_editor (base::ant::IConfiguration &oConfig, const char *strName, const char *strUrl)
 Sets graph element editor information. More...
 
void set_editors (base::ant::IConfiguration &oConfig, const std::vector< std::pair< std::string, std::string >> &oEditors)
 Sets multiple graph element editors. More...
 
base::flash::tNanoSeconds get_sample_time (const ant::ISample &oSample)
 Returns the sample timestamp with nanosecond precision. More...
 
void set_sample_time (const ucom::ant::iobject_ptr< ant::ISample > &pSample, base::flash::tNanoSeconds tmTimeStamp)
 Sets the sample timestamp with nanosecond precision. More...
 
void set_sample_time (ant::ISample &oSample, base::flash::tNanoSeconds tmTimeStamp)
 Sets the sample timestamp with nanosecond precision. More...
 

Detailed Description

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

Function Documentation

◆ get_sample_time()

base::flash::tNanoSeconds adtf::streaming::giant::get_sample_time ( const ant::ISample oSample)

Returns the sample timestamp with nanosecond precision.

This will check if the sample supports nanosecond precision (via adtf::streaming::flash::ISample) and convert the microseconds timestamp if not.

Parameters
oSampleThe sample.
Returns
The timestamp.

Referenced by sample_data< T >::GetTimeNs().

◆ set_description()

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

Sets description information.

See also
adtf::filter::flash::cGraphObject::SetDescription()
Parameters
[in]oConfigThe configuration instance where the name and url will be stored
[in]strDescriptionThe description.
Returns
Standard result.

◆ set_editor()

void adtf::streaming::giant::set_editor ( base::ant::IConfiguration oConfig,
const char *  strName,
const char *  strUrl 
)

Sets graph element editor information.

See also
adtf::filter::flash::cGraphObject::SetEditor()
Parameters
[in]oConfigThe configuration instance where the name and url will be stored
[in]strNameThe name of the editor.
[in]strUrlThe url to the editor (a qml file).
Returns
Standard result.

◆ set_editors()

void adtf::streaming::giant::set_editors ( base::ant::IConfiguration oConfig,
const std::vector< std::pair< std::string, std::string >> &  oEditors 
)

Sets multiple graph element editors.

See also
adtf::filter::flash::cGraphObject::SetEditor()
Parameters
[in]oConfigThe configuration instance where the names and urls will be stored
[in]oEditorsPairs of names and urls of the editors.
Returns
Standard result.

◆ set_sample_time() [1/2]

void adtf::streaming::giant::set_sample_time ( ant::ISample oSample,
base::flash::tNanoSeconds  tmTimeStamp 
)

Sets the sample timestamp with nanosecond precision.

This will check if the sample supports nanosecond precision (via adtf::streaming::flash::ISample) and convert the timestamp to microseconds if not.

Parameters
oSampleThe sample.
tmTimeStampThe timestamp.

◆ set_sample_time() [2/2]

void adtf::streaming::giant::set_sample_time ( const ucom::ant::iobject_ptr< ant::ISample > &  pSample,
base::flash::tNanoSeconds  tmTimeStamp 
)

Sets the sample timestamp with nanosecond precision.

This will check if the sample supports nanosecond precision (via adtf::streaming::flash::ISample) and convert the timestamp to microseconds if not.

Parameters
pSampleThe sample.
tmTimeStampThe timestamp.

Copyright © Audi Electronics Venture GmbH. All rights reserved. (Generated on Thu Jun 9 2022 by doxygen 1.9.1)