namespace for ADTF File library More...

Namespaces
	adtf2
	namespace for support of ADTF 2 files

	adtf3
	namespace for support of ADTF 3 files

	exceptions
	namespace for exceptions

Classes
class	InputStream
	interface class for input streams More...

class	StreamTypeDeserializer
	StreamType deserializer interface to deserialize a stream type. More...

class	StreamTypeDeserializers
	container class for StreamTypeDeserializers More...

class	SampleDeserializer
	Sample deserializer interface to deserialize a sample. More...

class	SampleDeserializerFactory
	SampleDeserializerFactory interface class. More...

class	sample_deserializer_factory
	default implementation template for a SampleDeserializerFactory creating More...

class	SampleDeserializerFactories
	container class for SampleDeserializerFactory More...

class	ADTFDatFileReader
	ADTF File Reader to deserialze and read the content of a ADTF DAT File. More...

class	ADTFDatFileReaderFactory
	Special Reader factory to make readers for "adtfdat" files. More...

class	OutputStream
	Interface class for an output stream. More...

class	StreamTypeSerializer
	interface class for stream type serializers. More...

class	ADTF2StreamTypeSerializer
	ADTF2 stream type serializer interface class to write ADTF 2 stream types. More...

class	StreamTypeSerializers
	Container class for StreamTypeSerializer. More...

class	SampleSerializer
	Interface class for a sample serializer. Usually the implementaion has a serialization state depending on the last setStreamType call. More...

class	SampleSerializerFactory
	interface class for sample serializer More...

class	sample_serializer_factory
	default implementation template for SampleSerializerFactory to create an instance of the serialzer type `SERIALIZER` More...

class	SampleSerializerFactories
	Container class for SampleSerializerFactory. More...

class	ADTFDatFileWriter
	Default ADTF DAT File Writer to write an ADTF DAT File (IFHD file with ADTF type and sample content). More...

struct	PropertyValue
	PropertyValue variant class. More...

class	Configurable

class	DefaultSample
	Default Sample implementation. More...

class	ReferencedFilesExtension
	Referenced File Extension Interpreter to hold a collection of file paths. This class is ables to read and write the collection of file paths as data content to a Reader extensions. More...

class	Object
	base interface class for all available objects of the ADTF File Library that can be added to the objects singleton of the library ( getObjects ). More...

class	Objects
	container for objects. this object container can be retrieved as objects singleton of the library via getObjects More...

class	PluginInitializer
	Plugin initializer class to use within a ADTF File Library plugin. More...

class	Extension
	Extension class for file extension. These extension are i.e.: More...

class	StreamTypeFactory
	Base class for a streamtype factory to create streamtypes used by the Reader. More...

class	stream_type_factory
	template class for a streamtype factory to create streamtypes with implementation type `STREAM_TYPE_CLASS` More...

class	SampleFactory
	Base class for a sample factory to create sample used by the Reader. More...

class	sample_factory
	template class for a sample factory to create sample with implementation type `SAMPLE_CLASS` More...

class	Stream
	class to create and describe a stream within a adtf_file::Reader. Each stream has an identifier `stream_id`. This `stream_id` is used to mark a corresponding FileItem More...

class	FileItem
	class to create or read a file item. This file item is either a sample, streamtype or trigger. More...

class	Reader

class	SeekableReader
	Interface for seekable Reader, where the file position can be adapted. More...

class	ExplicitReader

class	ReaderFactory
	Reader Factory interface to create a reader. More...

class	ReaderFactoryImplementation
	Default Reader factory implementation for readers using a standard default CTOR. More...

class	ReaderFactories

class	ReadSample
	Interface class for samples that are read from a Reader. More...

class	WriteSample
	Interface class for samples that are written. More...

class	ReadRawSampleInfo
	interface class for reading sample information. More...

class	WriteRawSampleInfo
	interface class for writing sample information. More...

class	StandardReader
	Standard Reader class to use the ADTFDatFileReader in default way. More...

class	StandardSampleSerializers
	Default container with all SampleSerializer factories provided by the ADTF File Library. More...

class	StandardSampleDeserializers
	Default container with all SampleDeserializer factories provided by the ADTF File Library. More...

class	StandardTypeDeserializers
	Default container with all StreamTypeDeserializer provided by the ADTF File Library. More...

class	StreamItem
	base class for either a sample, streamtype or trigger. Following stream items are possible: More...

class	StreamType
	Stream Type base class. More...

class	Sample
	Sample base class. More...

class	Trigger
	Trigger base class. More...

class	PropertyStreamType
	The default interface class for stream types. More...

class	DefaultStreamType
	Default stream type implementation. More...

Typedefs
using	Configuration = std::unordered_map< std::string, PropertyValue >
	Configuration class as set of key - property value pairs This configuration is used to adjust the readers and propcessors behaviour.

Enumerations
enum class	DataType { uint8 , int8 , uint16 , int16 , uint32 , int32 , uint64 , int64 , float32 , float64 }
	data type id for the adtf_file::ReadSample::addInfo call.

enum	SampleInfoKeys : uint32_t { sai_device_original_time = 1851393682 , sai_counter = 1660111993 }
	predefefined keys for the adtf_file::ReadSample::addInfo call.

Functions
std::string	getShortDescription (const std::string &description)
	helper fuction to retrieve short description out of `description` More...

std::string	getLongDescription (const std::string &description)
	helper fuction to retrieve long description out of `description` More...

bool	operator== (const PropertyValue &left, const PropertyValue &right)
	compare operator for PropertyValue More...

Configuration	operator+ (const Configuration &config_left, const Configuration &config_right)
	Add operator for configurations. More...

template<typename T >
T	getPropertyValue (const Configuration &configuration, const std::string &property_name)

template<typename T >
T	getPropertyValue (const Configuration &configuration, const std::string &property_name, const T &default_value)

template<typename T >
void	setPropertyValue (Configuration &configuration, const std::string &property_name, const T &property_value)

Objects &	getObjects ()
	Get the objects singleton of the library. More...

template<typename FACTORIES , typename FACTORY_TYPE >
FACTORIES	getFactories ()
	Get the Factories from the objects singleton of the library. More...

void	loadPlugin (const std::string &file_name)
	Loads a ADTF File Library plugin. More...

Stream	findStream (const Reader &reader, const std::string &stream_name)

std::chrono::nanoseconds	getFirstTimeOfStreams (const std::vector< Stream > &streams)
	Get the First Time Of the given Streams. More...

std::chrono::nanoseconds	getLastTimeOfStreams (const std::vector< Stream > &streams)
	Get the Last Time Of the given Streams. More...

ReaderFactories	getReaderFactories ()
	Get the Reader Factories from the Objects instance. More...

uint32_t	createSampleInfoHashKey (const std::string &name)
	Create a Sample Info Hash Key. More...

uint32_t	createAdtf2SampleInfoHashKey (uint32_t info_index)
	Create a Adtf2 Sample Info Hash Key. More...

void	add_standard_objects ()
	Adds all default implementation objects provided by the ADTF File Library.

Detailed Description

namespace for ADTF File library

The ADTF File package with 'adtf_file::ADTFDatFileWriter' and 'adtf_file::ADTFDatFileReader'. Depending on the ADTF File version you may create and read indexed files with samples.

Function Documentation

◆ createAdtf2SampleInfoHashKey()

uint32_t adtf_file::createAdtf2SampleInfoHashKey ( uint32_t info_index )

Create a Adtf2 Sample Info Hash Key.

Parameters

info_index the info index

Returns: uint32_t the hash

◆ createSampleInfoHashKey()

uint32_t adtf_file::createSampleInfoHashKey ( const std::string & name )

Create a Sample Info Hash Key.

Parameters

name	the name for the key

Returns: uint32_t the hash

◆ findStream()

Stream adtf_file::findStream	(	const Reader &	reader,
		const std::string &	stream_name
	)

Method to find a stream of a reader.

Parameters

[in]	reader	The reader.
[in]	stream_name	The name of the stream to look for.

Returns: The stream information.

◆ getFactories()

template<typename FACTORIES , typename FACTORY_TYPE >

FACTORIES adtf_file::getFactories ( )

Get the Factories from the objects singleton of the library.

Template Parameters

FACTORIES	the factories container type to add the found factories to
FACTORY_TYPE	the factory type to search for

Returns: the factories container with found factories of type FACTORY_TYPE

◆ getFirstTimeOfStreams()

std::chrono::nanoseconds adtf_file::getFirstTimeOfStreams ( const std::vector< Stream > & streams )

Get the First Time Of the given Streams.

Parameters

streams The streams vector

Returns: std::chrono::nanoseconds

◆ getLastTimeOfStreams()

std::chrono::nanoseconds adtf_file::getLastTimeOfStreams ( const std::vector< Stream > & streams )

Get the Last Time Of the given Streams.

Parameters

streams The streams vector

Returns: std::chrono::nanoseconds

◆ getLongDescription()

std::string adtf_file::getLongDescription ( const std::string & description )

inline

helper fuction to retrieve long description out of description

Parameters

description the decription to retrieve from

Returns: std::string

◆ getObjects()

Objects& adtf_file::getObjects ( )

Get the objects singleton of the library.

Returns: the objects singleton of the library

Remarks: This objects singleton of the library is only needed if ADTF File Library plugin mechanism is used. The singleton must be instanciated by the application only once before loading any plugin!

See also: loadPlugin

◆ getPropertyValue() [1/2]

template<typename T >

T adtf_file::getPropertyValue	(	const Configuration &	configuration,
		const std::string &	property_name
	)

Access property values and convert them to a specific type of T.

Parameters

[in]	configuration	The configuration.
[in]	property_name	The name of the property.

Template Parameters

T	the type to convert to.

Returns: The property value.

Exceptions

std::runtime_error if property_name does not exists or conversion is not possible

◆ getPropertyValue() [2/2]

template<typename T >

T adtf_file::getPropertyValue	(	const Configuration &	configuration,
		const std::string &	property_name,
		const T &	default_value
	)

Access property values and convert it to a specific type of T. If property_name is not found the default_value is returned

Parameters

[in]	configuration	The configuration.
[in]	property_name	The name of the property.
[in]	default_value	the default value if property not set.

Template Parameters

T	the type to convert to.

Returns: The property value.

Exceptions

std::runtime_error if conversion is not possible

◆ getReaderFactories()

ReaderFactories adtf_file::getReaderFactories ( )

Get the Reader Factories from the Objects instance.

Returns: ReaderFactories

◆ getShortDescription()

std::string adtf_file::getShortDescription ( const std::string & description )

inline

helper fuction to retrieve short description out of description

Parameters

description the decription to retrieve from

Returns: std::string

◆ loadPlugin()

void adtf_file::loadPlugin ( const std::string & file_name )

Loads a ADTF File Library plugin.

Parameters

file_name The path to the shared object providing a ADTF File Library plugin interface.

Remarks: the plugin will retrieve the objects singleton of the calling application by getObjects and will register its objects to it! Make sure the objects singleton is initialized only once before calling loadPlugin !

◆ operator+()

Configuration adtf_file::operator+	(	const Configuration &	config_left,
		const Configuration &	config_right
	)

inline

Add operator for configurations.

Parameters

config_left	the left configuration
config_right	the right configuration to add

Returns: Configuration

Remarks: if right configuration contains a value with the same key as left it will take the right one into concern

◆ operator==()

bool adtf_file::operator==	(	const PropertyValue &	left,
		const PropertyValue &	right
	)

inline

compare operator for PropertyValue

Parameters

left	the left value
right	the right value

Returns: true is equal in type and value; false is not equal in type or value

◆ setPropertyValue()

template<typename T >

void adtf_file::setPropertyValue	(	Configuration &	configuration,
		const std::string &	property_name,
		const T &	property_value
	)

Inserts or assigns the given property_value

Parameters

[in]	configuration	The configuration.
[in]	property_name	The name of the property.
[in]	property_value	The value to set.

Template Parameters

T	The type of the property_value. See PropertyValue CTORs

Namespaces

Classes

Typedefs

Enumerations

Functions

Detailed Description

Function Documentation

◆ createAdtf2SampleInfoHashKey()

◆ createSampleInfoHashKey()

◆ findStream()

◆ getFactories()

◆ getFirstTimeOfStreams()

◆ getLastTimeOfStreams()

◆ getLongDescription()

◆ getObjects()

◆ getPropertyValue() [1/2]

◆ getPropertyValue() [2/2]

◆ getReaderFactories()

◆ getShortDescription()

◆ loadPlugin()

◆ operator+()

◆ operator==()

◆ setPropertyValue()