Vector BLF
Vector::BLF::LogContainer Struct Referencefinal

LOG_CONTAINER. More...

#include <LogContainer.h>

Inheritance diagram for Vector::BLF::LogContainer:
Inheritance graph
Collaboration diagram for Vector::BLF::LogContainer:
Collaboration graph

Public Member Functions

void read (AbstractFile &is) override
 
void write (AbstractFile &os) override
 
DWORD calculateObjectSize () const override
 
WORD internalHeaderSize () const
 
virtual void uncompress ()
 
virtual void compress (const WORD compressionMethod, const int compressionLevel)
 
- Public Member Functions inherited from Vector::BLF::ObjectHeaderBase
 ObjectHeaderBase (const WORD headerVersion, const ObjectType objectType)
 
 ObjectHeaderBase (const ObjectHeaderBase &)=default
 
ObjectHeaderBaseoperator= (const ObjectHeaderBase &)=default
 
 ObjectHeaderBase (ObjectHeaderBase &&)=default
 
ObjectHeaderBaseoperator= (ObjectHeaderBase &&)=default
 
virtual WORD calculateHeaderSize () const
 

Public Attributes

WORD compressionMethod {}
 
WORD reservedLogContainer1 {}
 
DWORD reservedLogContainer2 {}
 
DWORD uncompressedFileSize {}
 
DWORD reservedLogContainer3 {}
 
std::vector< uint8_t > compressedFile {}
 
std::vector< uint8_t > uncompressedFile {}
 
DWORD compressedFileSize {}
 
std::streampos filePosition {}
 
- Public Attributes inherited from Vector::BLF::ObjectHeaderBase
DWORD signature {ObjectSignature}
 signature (ObjectSignature) More...
 
WORD headerSize {}
 sizeof object header More...
 
WORD headerVersion {}
 header version (1) More...
 
DWORD objectSize {}
 object size More...
 
ObjectType objectType {}
 object type More...
 

Detailed Description

LOG_CONTAINER.

Member Function Documentation

◆ calculateObjectSize()

DWORD Vector::BLF::LogContainer::calculateObjectSize ( ) const
overridevirtual

Calculates the objectSize

Returns
object size

Reimplemented from Vector::BLF::ObjectHeaderBase.

◆ compress()

void Vector::BLF::LogContainer::compress ( const WORD  compressionMethod,
const int  compressionLevel 
)
virtual

compress data

Parameters
[in]compressionMethodcompression method
[in]compressionLevelcompression level (different for each method)

◆ internalHeaderSize()

WORD Vector::BLF::LogContainer::internalHeaderSize ( ) const

internalHeaderSize returns the size of all headers.

Note
Not to be mixed with headerSize, which only takes ObjectHeaderBase headers into account.
Returns
Size of all headers.

◆ read()

void Vector::BLF::LogContainer::read ( AbstractFile is)
overridevirtual

Read the data of this object

Parameters
isinput stream

Reimplemented from Vector::BLF::ObjectHeaderBase.

◆ uncompress()

void Vector::BLF::LogContainer::uncompress ( )
virtual

uncompress data

◆ write()

void Vector::BLF::LogContainer::write ( AbstractFile os)
overridevirtual

Write the data of this object

Parameters
osoutput stream

Reimplemented from Vector::BLF::ObjectHeaderBase.

Member Data Documentation

◆ compressedFile

std::vector<uint8_t> Vector::BLF::LogContainer::compressedFile {}

compressed file content

◆ compressedFileSize

DWORD Vector::BLF::LogContainer::compressedFileSize {}

compressed file size in bytes

◆ compressionMethod

WORD Vector::BLF::LogContainer::compressionMethod {}

compression method

  • 0: no compression
  • 2: zlib deflate

◆ filePosition

std::streampos Vector::BLF::LogContainer::filePosition {}

position of this LogContainer::uncompressedFile within UncompressedFile class

◆ reservedLogContainer1

WORD Vector::BLF::LogContainer::reservedLogContainer1 {}

reserved

◆ reservedLogContainer2

DWORD Vector::BLF::LogContainer::reservedLogContainer2 {}

reserved

◆ reservedLogContainer3

DWORD Vector::BLF::LogContainer::reservedLogContainer3 {}

reserved

◆ uncompressedFile

std::vector<uint8_t> Vector::BLF::LogContainer::uncompressedFile {}

uncompressed file content

◆ uncompressedFileSize

DWORD Vector::BLF::LogContainer::uncompressedFileSize {}

uncompressed file size in bytes


The documentation for this struct was generated from the following files: