.TH "Vector::BLF::LogContainer" 3 "Vector BLF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
Vector::BLF::LogContainer \- LOG_CONTAINER\&.  

.SH SYNOPSIS
.br
.PP
.PP
\fR#include <LogContainer\&.h>\fP
.PP
Inherits \fBVector::BLF::ObjectHeaderBase\fP\&.
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "void \fBread\fP (\fBAbstractFile\fP &is) override"
.br
.ti -1c
.RI "void \fBwrite\fP (\fBAbstractFile\fP &os) override"
.br
.ti -1c
.RI "uint32_t \fBcalculateObjectSize\fP () const override"
.br
.ti -1c
.RI "uint16_t \fBinternalHeaderSize\fP () const"
.br
.ti -1c
.RI "virtual void \fBuncompress\fP ()"
.br
.ti -1c
.RI "virtual void \fBcompress\fP (const uint16_t \fBcompressionMethod\fP, const int compressionLevel)"
.br
.in -1c

Public Member Functions inherited from \fBVector::BLF::ObjectHeaderBase\fP
.in +1c
.ti -1c
.RI "\fBObjectHeaderBase\fP (const uint16_t \fBheaderVersion\fP, const ObjectType \fBobjectType\fP)"
.br
.ti -1c
.RI "\fBObjectHeaderBase\fP (const ObjectHeaderBase &)=default"
.br
.ti -1c
.RI "ObjectHeaderBase & \fBoperator=\fP (const ObjectHeaderBase &)=default"
.br
.ti -1c
.RI "\fBObjectHeaderBase\fP (ObjectHeaderBase &&)=default"
.br
.ti -1c
.RI "ObjectHeaderBase & \fBoperator=\fP (ObjectHeaderBase &&)=default"
.br
.ti -1c
.RI "virtual uint16_t \fBcalculateHeaderSize\fP () const"
.br
.in -1c
.SS "Public Attributes"

.in +1c
.ti -1c
.RI "uint16_t \fBcompressionMethod\fP {}"
.br
.ti -1c
.RI "uint16_t \fBreservedLogContainer1\fP {}"
.br
.ti -1c
.RI "uint32_t \fBreservedLogContainer2\fP {}"
.br
.ti -1c
.RI "uint32_t \fBuncompressedFileSize\fP {}"
.br
.ti -1c
.RI "uint32_t \fBreservedLogContainer3\fP {}"
.br
.ti -1c
.RI "std::vector< uint8_t > \fBcompressedFile\fP {}"
.br
.ti -1c
.RI "std::vector< uint8_t > \fBuncompressedFile\fP {}"
.br
.ti -1c
.RI "uint32_t \fBcompressedFileSize\fP {}"
.br
.ti -1c
.RI "std::streampos \fBfilePosition\fP {}"
.br
.in -1c

Public Attributes inherited from \fBVector::BLF::ObjectHeaderBase\fP
.in +1c
.ti -1c
.RI "uint32_t \fBsignature\fP {ObjectSignature}"
.br
.RI "signature (ObjectSignature) "
.ti -1c
.RI "uint16_t \fBheaderSize\fP {}"
.br
.RI "sizeof object header "
.ti -1c
.RI "uint16_t \fBheaderVersion\fP {}"
.br
.RI "header version (1) "
.ti -1c
.RI "uint32_t \fBobjectSize\fP {}"
.br
.RI "object size "
.ti -1c
.RI "ObjectType \fBobjectType\fP {ObjectType::UNKNOWN}"
.br
.RI "object type "
.in -1c
.SH "Detailed Description"
.PP 
LOG_CONTAINER\&. 
.SH "Member Function Documentation"
.PP 
.SS "uint32_t Vector::BLF::LogContainer::calculateObjectSize () const\fR [override]\fP, \fR [virtual]\fP"
Calculates the objectSize

.PP
\fBReturns\fP
.RS 4
object size 
.RE
.PP

.PP
Reimplemented from \fBVector::BLF::ObjectHeaderBase\fP\&.
.SS "void Vector::BLF::LogContainer::compress (const uint16_t compressionMethod, const int compressionLevel)\fR [virtual]\fP"
compress data

.PP
\fBParameters\fP
.RS 4
\fI\fBcompressionMethod\fP\fP compression method 
.br
\fIcompressionLevel\fP compression level (different for each method) 
.RE
.PP

.SS "uint16_t Vector::BLF::LogContainer::internalHeaderSize () const"
internalHeaderSize returns the size of all headers\&.

.PP
\fBNote\fP
.RS 4
Not to be mixed with headerSize, which only takes \fBObjectHeaderBase\fP headers into account\&.
.RE
.PP
\fBReturns\fP
.RS 4
Size of all headers\&. 
.RE
.PP

.SS "void Vector::BLF::LogContainer::read (\fBAbstractFile\fP & is)\fR [override]\fP, \fR [virtual]\fP"
Read the data of this object

.PP
\fBParameters\fP
.RS 4
\fIis\fP input stream 
.RE
.PP

.PP
Reimplemented from \fBVector::BLF::ObjectHeaderBase\fP\&.
.SS "void Vector::BLF::LogContainer::uncompress ()\fR [virtual]\fP"
uncompress data 
.SS "void Vector::BLF::LogContainer::write (\fBAbstractFile\fP & os)\fR [override]\fP, \fR [virtual]\fP"
Write the data of this object

.PP
\fBParameters\fP
.RS 4
\fIos\fP output stream 
.RE
.PP

.PP
Reimplemented from \fBVector::BLF::ObjectHeaderBase\fP\&.
.SH "Member Data Documentation"
.PP 
.SS "std::vector<uint8_t> Vector::BLF::LogContainer::compressedFile {}"
compressed file content 
.SS "uint32_t Vector::BLF::LogContainer::compressedFileSize {}"
compressed file size in bytes 
.SS "uint16_t Vector::BLF::LogContainer::compressionMethod {}"
compression method

.PP
.IP "\(bu" 2
0: no compression
.IP "\(bu" 2
2: zlib deflate 
.PP

.SS "std::streampos Vector::BLF::LogContainer::filePosition {}"
position of this \fBLogContainer::uncompressedFile\fP within \fBUncompressedFile\fP class 
.SS "uint16_t Vector::BLF::LogContainer::reservedLogContainer1 {}"
reserved 
.SS "uint32_t Vector::BLF::LogContainer::reservedLogContainer2 {}"
reserved 
.SS "uint32_t Vector::BLF::LogContainer::reservedLogContainer3 {}"
reserved 
.SS "std::vector<uint8_t> Vector::BLF::LogContainer::uncompressedFile {}"
uncompressed file content 
.SS "uint32_t Vector::BLF::LogContainer::uncompressedFileSize {}"
uncompressed file size in bytes 

.SH "Author"
.PP 
Generated automatically by Doxygen for Vector BLF from the source code\&.