Vector::BLF::File(3) Library Functions Manual Vector::BLF::File(3)

Vector::BLF::File

#include <File.h>


virtual void open (const char *filename, const std::ios_base::openmode mode=std::ios_base::in)
virtual void open (const std::string &filename, const std::ios_base::openmode mode=std::ios_base::in)
virtual bool is_open () const
virtual bool good () const
virtual bool eof () const
virtual ObjectHeaderBase * read ()
virtual void write (ObjectHeaderBase *ohb)
virtual void close ()
virtual uint32_t defaultLogContainerSize () const
virtual void setDefaultLogContainerSize (uint32_t defaultLogContainerSize)


static ObjectHeaderBase * createObject (ObjectType type)


FileStatistics fileStatistics {}
uint64_t currentUncompressedFileSize {}
std::atomic< uint32_t > currentObjectCount {}
int compressionLevel {1}
bool writeRestorePoints {true}

File

This is similar to std::fstream for BLFs

close file

ObjectHeaderBase * Vector::BLF::File::createObject (ObjectType type) [static]

create object of given type

Parameters

type object type

Returns

new object

Get default log container size.

Returns

default log container size

Check whether eofbit is set.

Returns

true if end-of-file reached

Check whether state of stream is good.

Returns

true if no error flags set

is file open?

Returns

true if file is open

open file

Parameters

filename file name
mode open mode, either in (read) or out (write)

open file

Parameters

filename file name
mode open mode, either in (read) or out (write)

ObjectHeaderBase * Vector::BLF::File::read () [virtual]

Read object from file.

Ownership is taken over from the library to the user. The user has to take care to delete the object.

Todo

Use std::unique_ptr in future versions.

Returns

read object or nullptr

Set default log container size.

Parameters

defaultLogContainerSize default log container size

Write object to file.

Ownership is taken over from the user to the library. The object should not be further accessed any more.

Todo

Use std::unique_ptr in future versions.

Parameters

ohb write object

compression level

zlib compression levels:

  • 0: Z_NO_COMPRESSION
  • 1: Z_BEST_SPEED
  • 9: Z_BEST_COMPRESSION

Vector BLF compression levels:

  • 0: no compression
  • 6: default compression
  • 10: maximum compression

Current number of objects read

Unknown115 is not counted.

Current uncompressed file size

This includes the LogContainer headers, and the uncompressed content.

FileStatistics Vector::BLF::File::fileStatistics {}

File statistics from file header. contains total counts/sizes

Write restore points at file close.

Generated automatically by Doxygen for Vector BLF from the source code.

Vector BLF