adtf_file_library  0.13.1
Public Member Functions | List of all members
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:
[legend]
Collaboration diagram for adtfdat_processing::ReferencedFilesReader:
[legend]

Public Member Functions

 ReferencedFilesReader ()
 CTOR.
 
std::string getReaderIdentifier () const override
 Get the Reader Identifier of the Reader. More...
 
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 More...
 
- Public Member Functions inherited from adtfdat_processing::MultiFileReader
 MultiFileReader ()
 CTOR.
 
std::vector< adtf_file::StreamgetStreams () const override
 Get the Streams. More...
 
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. More...
 
std::optional< double > getProgress () const override
 Get the Progress, a relative file position between 0.0 and 1.0. More...
 
- Public Member Functions inherited from adtf_file::Reader
virtual uint32_t getFileVersion () const
 
virtual std::string getDescription () const
 
virtual std::vector< ExtensiongetExtensions () const
 Get the Extensions if any. More...
 
- Public Member Functions inherited from adtf_file::Configurable
virtual ~Configurable ()=default
 DTOR.
 
virtual const ConfigurationgetConfiguration () 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. More...
 
std::shared_ptr< adtf_file::ReaderaddFile (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. More...
 
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
filenameThe file to open
sample_factoryThe sample factory to create samples for the getNextItem call.
stream_type_factoryThe 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::exceptionbased 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:

Copyright © CARIAD SE.
Generated on Fri Apr 19 2024 by doxygen 1.9.1
GIT Commit Hash: 82d535f82776c20b12fc60740bdae991b62444a7