adtf_file_library  0.13.2
Public Member Functions | List of all members
ifhd::v500::IndexedFileWriter Class Reference

More...

#include <indexedfilewriter_v500.h>

Inheritance diagram for ifhd::v500::IndexedFileWriter:
[legend]
Collaboration diagram for ifhd::v500::IndexedFileWriter:
[legend]

Public Member Functions

 IndexedFileWriter ()
 
uint32_t getSupportedVersion () const
 Get the Supported Version. More...
 
- Public Member Functions inherited from ifhd::v400::IndexedFileWriter
 IndexedFileWriter ()
 
uint32_t getSupportedVersion () const
 Get the Supported Version. More...
 
- Public Member Functions inherited from ifhd::v201_v301::IndexedFileWriter
std::string getTempSaveFileName ()
 
void setPrefixTempFileExtension (bool use_mode)
 
bool getPrefixTempFileExtensionMode () const
 
std::string getPrefix () const
 
std::string getNewFileNameWithPrefix (const std::string &filename) const
 
 IndexedFileWriter ()
 
 ~IndexedFileWriter ()
 
void setDateTime (const a_util::datetime::DateTime &date_time)
 Sets the date and time of the file. More...
 
void open (const std::string &filename, uint32_t flags=0, uint64_t file_time_offset=0, timestamp_t history=0, utils5ext::FileSize history_size=0, ChunkDroppedCallback *drop_callback=nullptr, timestamp_t index_delay=1000000)
 
void close ()
 
void writeChunk (uint16_t stream_id, const void *data, uint32_t data_size, timestamp_t time_stamp, uint32_t flags)
 
void writeChunk (uint16_t stream_id, const void *data, uint32_t data_size, timestamp_t time_stamp, uint32_t flags, bool &index_entry_appended)
 
void setAdditionalStreamInfo (uint16_t stream_id, const void *info_data, uint32_t info_data_size, bool use_as_reference=false)
 
void setStreamName (uint16_t stream_id, const char *stream_name)
 
void quitHistory ()
 
- Public Member Functions inherited from ifhd::v201_v301::IndexedFile
 IndexedFile ()
 
virtual ~IndexedFile ()
 
virtual std::set< uint32_t > getSupportedVersions () const
 Get a set of all supported versions. More...
 
void setDescription (const std::string &description)
 
std::string getDescription () const
 
std::string getGUID () const
 
a_util::datetime::DateTime getDateTime () const
 
uint8_t getByteOrder () const
 
size_t getExtensionCount () const
 
bool findExtension (const char *identifier, FileExtension **extension_info, void **data) const
 
void getExtension (size_t index, FileExtension **extension_info, void **data) const
 
void appendExtension (const char *identifier, const void *data, size_t data_size, uint32_t type_id=0, uint32_t file_version_id=0, uint16_t stream_id=0, uint32_t user_id=0)
 
void appendExtension (const void *data, const FileExtension *extension_info)
 
void freeExtensions ()
 
void getHeaderRef (FileHeader **file_header) const
 

Additional Inherited Members

- Protected Types inherited from ifhd::v201_v301::IndexedFile
typedef std::list< FileExtensionStruct * > FileExtensionList
 own type definition for a better work with file extension lists
 
- Protected Member Functions inherited from ifhd::v201_v301::IndexedFileWriter
void initialize ()
 
void writeFileHeader ()
 
void writeFileHeaderExt ()
 
void writeIndexTable ()
 
- Protected Member Functions inherited from ifhd::v201_v301::IndexedFile
void setDateTime (const a_util::datetime::DateTime &date_time)
 
void allocBuffer (uint64_t size)
 
void freeBuffer ()
 
void allocHeader ()
 
void freeHeader ()
 
void allocExtensionPage (utils5ext::FileSize size, void **data) const
 
void setGUID ()
 
void generateNewGUID (std::string &generated_guid)
 
void allocCache (int64_t size)
 
void freeCache ()
 
void * getCacheAddr () const
 
void * internalMalloc (size_t size) const
 
void internalFree (void *memory) const
 
- Protected Attributes inherited from ifhd::v201_v301::IndexedFileWriter
bool _use_prefix_temp_file_extension
 
- Protected Attributes inherited from ifhd::v201_v301::IndexedFile
utils5ext::File _file
 the open file
 
FilePos _file_pos
 current filepos
 
uint8_t * _buffer
 internal Buffer
 
int64_t _buffer_size
 internal Buffer size
 
FileHeader_file_header
 current file header
 
bool _write_guid
 protection for writing GUID
 
FileExtensionList _extensions
 list with all extensions
 
void * _cache
 cache data area
 
uint64_t _cache_size
 size of cache
 
bool _write_mode
 For internal use only (will be moved to a private implementation).
 
- Static Protected Attributes inherited from ifhd::v201_v301::IndexedFile
static const uint8_t byte_order
 current value of platform ByteOrder ( More...
 
static int64_t default_block_size
 Default block size in bytes.
 
static int64_t default_cache_size
 Default cache size in bytes.
 

Detailed Description

Class for writing indexed files.

Constructor & Destructor Documentation

◆ IndexedFileWriter()

ifhd::v500::IndexedFileWriter::IndexedFileWriter ( )
inline

CTOR

Member Function Documentation

◆ getSupportedVersion()

uint32_t ifhd::v500::IndexedFileWriter::getSupportedVersion ( ) const
inline

Get the Supported Version.

Returns
uint32_t

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

Copyright © CARIAD SE.
Generated on Mon Jun 10 2024 by doxygen 1.9.1
GIT Commit Hash: eb3af397a6b49ad6fcad9a60d8277d909b458b48