adtfdat_processing::ReferencedFilesReader Class Reference

Reader implementation to read multiple files and its referenced files extension. More...

#include <referenced_files_reader.h>

Inheritance diagram for adtfdat_processing::ReferencedFilesReader:

Collaboration diagram for adtfdat_processing::ReferencedFilesReader:

Public Member Functions
	ReferencedFilesReader ()
	CTOR.
std::string	getReaderIdentifier () const override
	Get the Reader Identifier of the Reader.
void	open (const std::string &file_name, std::shared_ptr< adtf_file::SampleFactory > sample_factory, std::shared_ptr< adtf_file::StreamTypeFactory > stream_type_factory) override
	opens a file by the given filename. The given factories must be used to create samples and streamtypes for the getNextItem call
Public Member Functions inherited from adtfdat_processing::MultiFileReader
	MultiFileReader ()
	CTOR.
std::vector< adtf_file::Stream >	getStreams () const override
	Get the Streams.
adtf_file::FileItem	getNextItem () override
std::optional< uint64_t >	getItemCount () const override
	Get the Item Count. This gets the overall count of all items (samples, stream types and triggers) of all streams.
std::optional< double >	getProgress () const override
	Get the Progress, a relative file position between 0.0 and 1.0.
uint64_t	getItemIndexForTimeStamp (std::chrono::nanoseconds time_stamp) override
uint64_t	getItemIndexForStreamItemIndex (uint16_t stream_id, uint64_t stream_item_index) override
std::shared_ptr< const adtf_file::StreamType >	getStreamTypeBefore (uint64_t item_index, uint16_t stream_id) override
void	seekTo (uint64_t item_index) override
Public Member Functions inherited from adtf_file::Reader
virtual uint32_t	getFileVersion () const
virtual std::string	getDescription () const
virtual std::vector< Extension >	getExtensions () const
	Get the Extensions if any.
Public Member Functions inherited from adtf_file::Configurable
virtual	~Configurable ()=default
	DTOR.
virtual const Configuration &	getConfiguration () const
virtual void	setConfiguration (const Configuration &configuration)

Additional Inherited Members
Protected Member Functions inherited from adtfdat_processing::MultiFileReader
virtual adtf_file::ReaderFactories	getFactories () const
	Get all supported reader factories of this multireader.
std::shared_ptr< adtf_file::Reader >	addFile (const std::string &file_name, std::shared_ptr< adtf_file::SampleFactory > sample_factory, std::shared_ptr< adtf_file::StreamTypeFactory > stream_type_factory)
	Adds a file to the multi file reader and opens the file if supported.
void	build ()
	Merges the streams.

Detailed Description

Reader implementation to read multiple files and its referenced files extension.

See also

adtf_file::ReferencedFilesExtension

Member Function Documentation

getReaderIdentifier()

std::string adtfdat_processing::ReferencedFilesReader::getReaderIdentifier ( ) const

overridevirtual

Get the Reader Identifier of the Reader.

Returns

the reader identifier

Reimplemented from adtfdat_processing::MultiFileReader.

open()

void adtfdat_processing::ReferencedFilesReader::open ( const std::string & filename, std::shared_ptr< adtf_file::SampleFactory > sample_factory, std::shared_ptr< adtf_file::StreamTypeFactory > stream_type_factory )

overridevirtual

opens a file by the given filename. The given factories must be used to create samples and streamtypes for the getNextItem call

Parameters

filename	The file to open
sample_factory	The sample factory to create samples for the getNextItem call.
stream_type_factory	The stream type factory to create streamtype for the getNextItem call.

Remarks

The Reader class is an interface where implementation should at least throw following exceptions in case of error:

Exceptions

std::exception

based exception for any other implementation dependent case to identify error on open call

Reimplemented from adtfdat_processing::MultiFileReader.

---

The documentation for this class was generated from the following file:

• include/adtfdat_processing/referenced_files_reader.h