ADTF  3.13.2
adtf::mediadescription::flash Namespace Reference

Namespace for all functionality provided since v3.5. More...

Classes

struct  arithmetic_type
 Type implementation for arithmetic (POD) types. More...
 
class  cDDLPrinter
 Generates a DDL description from a structure definition. More...
 
class  cDumper
 Dumps a structure definition to an output stream. More...
 
class  cEnumerationType
 Type implementation for enumerations. More...
 
class  cSampleCodecFactory
 
class  cSampleWithCodec
 Helper class that combines a Sample Codec with a Sample instance. More...
 
class  cStructureType
 Type implementation for structures. More...
 
class  cType
 Base class for types. More...
 
class  decoding_sample_reader
 This reader uses the media description to decode sample data. More...
 
struct  description
 Template to provide struct name and definition for a generated struct. More...
 
class  encoding_sample_writer
 Sample Writer that provides samples that can be updated via a Codec. More...
 
class  enumeration
 This is used to create an enumeration ytpe from an existing c++ enum. More...
 
class  enumeration< Type, typename std::enable_if< std::is_enum< Type >::value >::type >
 
class  enumeration< UnderlyingType, typename std::enable_if< std::is_integral< UnderlyingType >::value >::type >
 This is used to create an enumeration type independently. More...
 
struct  indices
 Internal helper class. More...
 
class  md_array
 This class is used to wrap access to arrays of plain and enum types. More...
 
class  md_sample_data
 Template to provide media description based access to Sample data. More...
 
class  md_sample_data_factory
 This factory provides instances of md_sample_data for incoming samples. More...
 
class  md_struct_array
 This class is used to wrap access to arrays of struct types. More...
 
class  structure
 This is used to create a structure type from an existing c++ struct definition. More...
 
class  structure< void >
 This is used to create a structure type independently. More...
 

Functions

std::ostream & operator<< (std::ostream &oStream, const cDDLPrinter &oPrinter)
 
std::ostream & operator<< (std::ostream &oStream, const cDumper &cDumper)
 
template<typename WRITER >
tResult make_sample_writer (WRITER &oWriter, const tChar *strNameOfWriter, const tChar *strDDLStructType)
 Helper template to setup a sample writer with a stream type set from the media description service. More...
 
template<typename READER >
tResult make_sample_reader (READER &oReader, const tChar *strNameOfReader, const tChar *strDDLStructType)
 Helper template to setup a sample reader with a stream type set from the media description service. More...
 
ucom::ant::object_ptr< streaming::ant::IStreamTypecreate_adtf_default_stream_type (const cStructureType &type_definition)
 Create a stream type containing the media description of a given structure type definition. More...
 
ucom::ant::object_ptr< streaming::ant::IStreamTypecreate_adtf_default_stream_type (const tChar *strStructName, const tChar *strMediaDescription)
 Create a stream type continaing the given media description. More...
 
template<typename Struct >
ucom::ant::object_ptr< streaming::ant::IStreamTypecreate_adtf_default_stream_type ()
 Create a stream type from a generated media description. More...
 
tResult set_media_description_properties (base::ant::IProperties &oProperties, const tChar *strStructName, const tChar *strMediaDescription, adtf_ddl::tDataRepresentation eRep=adtf_ddl::tDataRepresentation::Deserialized)
 Adds the media description properties to a properties object. More...
 
tResult set_media_description_properties (base::ant::IProperties &oProperties, const cStructureType &type_definition, adtf_ddl::tDataRepresentation eRep=adtf_ddl::tDataRepresentation::Deserialized)
 Adds the media description properties to a properties object. More...
 
void set_stream_type_media_description (streaming::ant::IStreamType &oStreamType, const cStructureType &type_definition)
 Adds the media description properties to a stream type. More...
 

Detailed Description

Namespace for all functionality provided since v3.5.

Function Documentation

◆ create_adtf_default_stream_type() [1/3]

ucom::ant::object_ptr<streaming::ant::IStreamType> adtf::mediadescription::flash::create_adtf_default_stream_type ( const cStructureType type_definition)

Create a stream type containing the media description of a given structure type definition.

Parameters
[in]type_definitionA structure type definition.
Returns
A stream type containing the media description of the given type definition.
Exceptions
tResultin case of error.

Referenced by create_adtf_default_stream_type().

◆ create_adtf_default_stream_type() [2/3]

ucom::ant::object_ptr<streaming::ant::IStreamType> adtf::mediadescription::flash::create_adtf_default_stream_type ( const tChar strStructName,
const tChar strMediaDescription 
)

Create a stream type continaing the given media description.

Parameters
[in]strStructNameThe name of the struct.
[in]strMediaDescriptionThe description containing the struct definition.
Returns
A stream type containing the given media description.
Exceptions
tResultin case of error.

◆ create_adtf_default_stream_type() [3/3]

ucom::ant::object_ptr<streaming::ant::IStreamType> adtf::mediadescription::flash::create_adtf_default_stream_type ( )

Create a stream type from a generated media description.

Template Parameters
StructThe struct that has been generated via Creating a DDL file and use it.
Returns
A stream type containing a generated media description.

Definition at line 245 of file media_description_type.h.

References create_adtf_default_stream_type().

◆ make_sample_reader()

tResult adtf::mediadescription::flash::make_sample_reader ( READER &  oReader,
const tChar strNameOfReader,
const tChar strDDLStructType 
)
inline

Helper template to setup a sample reader with a stream type set from the media description service.

Parameters
[in,out]oReaderThe reader that should be setup.
[in]strNameOfReaderThe name of the reader, which will be used to create an input pin.
[in]strDDLStructTypeThe name of the struct that the description should be retrieved from the media description service.
Returns
Standard result.

Definition at line 212 of file media_description_type.h.

References adtf::mediadescription::ant::create_adtf_default_stream_type_from_service(), and RETURN_IF_FAILED.

◆ make_sample_writer()

tResult adtf::mediadescription::flash::make_sample_writer ( WRITER &  oWriter,
const tChar strNameOfWriter,
const tChar strDDLStructType 
)
inline

Helper template to setup a sample writer with a stream type set from the media description service.

Parameters
[in,out]oWriterThe writer that should be setup.
[in]strNameOfWriterThe name of the writer, which will be used to create an output pin.
[in]strDDLStructTypeThe name of the struct that the description should be retrieved from the media description service.
Returns
Standard result.

Definition at line 195 of file media_description_type.h.

References adtf::mediadescription::ant::create_adtf_default_stream_type_from_service(), and RETURN_IF_FAILED.

◆ set_media_description_properties() [1/2]

tResult adtf::mediadescription::flash::set_media_description_properties ( base::ant::IProperties oProperties,
const tChar strStructName,
const tChar strMediaDescription,
adtf_ddl::tDataRepresentation  eRep = adtf_ddl::tDataRepresentation::Deserialized 
)

Adds the media description properties to a properties object.

Parameters
[out]oPropertiesThe properties object where the properties should be added/set to.
[in]strStructNameThe name of the struct.
[in]strMediaDescriptionThe media description containing the struct definition.
[in]eRepThe data representation of the struct that samples contain.
Returns
Standard result.

◆ set_media_description_properties() [2/2]

tResult adtf::mediadescription::flash::set_media_description_properties ( base::ant::IProperties oProperties,
const cStructureType type_definition,
adtf_ddl::tDataRepresentation  eRep = adtf_ddl::tDataRepresentation::Deserialized 
)

Adds the media description properties to a properties object.

Parameters
[out]oPropertiesThe properties object where the properties should be added/set to.
[in]type_definitionA structure type definition.
[in]eRepThe data representation of the struct that samples contain.
Returns
Standard result.

◆ set_stream_type_media_description()

void adtf::mediadescription::flash::set_stream_type_media_description ( streaming::ant::IStreamType oStreamType,
const cStructureType type_definition 
)

Adds the media description properties to a stream type.

Parameters
[out]oStreamTypeThe stream type where the properties should be added/set to.
[in]type_definitionA structure type definition.
Exceptions
tResultin case of error.

Copyright © Audi Electronics Venture GmbH. All rights reserved. (Generated on Tue Nov 16 2021 by doxygen 1.8.14)