adtf_file_library  0.13.1
Public Member Functions | List of all members
adtf_file::StandardReader Class Reference

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

#include <standard_adtf_file_reader.h>

Inheritance diagram for adtf_file::StandardReader:
[legend]
Collaboration diagram for adtf_file::StandardReader:
[legend]

Public Member Functions

 StandardReader (const ADTFDatFileReader &)=delete
 
 StandardReader (StandardReader &&)=default
 CTOR.
 
 ~StandardReader ()=default
 DTOR.
 
 StandardReader (const std::string &file_name, const Configuration &configuration={})
 CTOR opens a ADTF DAT file with given configuration. More...
 
- Public Member Functions inherited from adtf_file::ADTFDatFileReader
 ADTFDatFileReader ()
 
 ADTFDatFileReader (std::optional< StreamTypeDeserializers > type_factories, std::optional< SampleDeserializerFactories > sample_deserializer_factories)
 CTOR for a new Reader. More...
 
 ADTFDatFileReader (const ADTFDatFileReader &)=delete
 
 ADTFDatFileReader (ADTFDatFileReader &&)=default
 Move CTOR.
 
std::string getReaderIdentifier () const override
 Get the Reader Identifier of the Reader. More...
 
void open (const std::string &filename, std::shared_ptr< SampleFactory > sample_factory, std::shared_ptr< StreamTypeFactory > stream_type_factory) override
 CTOR for a new Reader. More...
 
void open (const std::string &filename)
 a file and uses default sample and stream type factories. More...
 
FileItem getNextItem () override
 
uint32_t getFileVersion () const override
 
std::string getDescription () const override
 
std::vector< ExtensiongetExtensions () const override
 Get the Extensions if any. More...
 
std::vector< StreamgetStreams () const override
 Get the Streams. More...
 
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...
 
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 StreamTypegetStreamTypeBefore (uint64_t item_index, uint16_t stream_id) override
 
void seekTo (uint64_t item_index) override
 
int64_t getNextItemIndex () const
 
a_util::datetime::DateTime getDateTime () const
 Get the File Date Time of creating the adtfdat file from fileheader. More...
 
std::chrono::nanoseconds getFirstTime () const
 Get the timestamp of the very first file item. More...
 
std::chrono::nanoseconds getLastTime () const
 Get the timestamp of the very last file item. 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

- Static Public Attributes inherited from adtf_file::ADTFDatFileReader
static constexpr int64_t read_cache_default = -1
 
static constexpr int64_t read_cache_deactivated = 0
 

Detailed Description

Standard Reader class to use the ADTFDatFileReader in default way.

Constructor & Destructor Documentation

◆ StandardReader()

adtf_file::StandardReader::StandardReader ( const std::string &  file_name,
const Configuration configuration = {} 
)
inline

CTOR opens a ADTF DAT file with given configuration.

Parameters
file_namethe filepath to the ADTF DAT file
configurationthe configuration, see adtf_file::ADTFDatFileReader::ADTFDatFileReader

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