.TH "Vector::BLF::FileStatistics" 3 "Vector BLF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
Vector::BLF::FileStatistics
.SH SYNOPSIS
.br
.PP
.PP
\fR#include <FileStatistics\&.h>\fP
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBFileStatistics\fP (\fBconst\fP \fBFileStatistics\fP &)=\fBdefault\fP"
.br
.ti -1c
.RI "\fBFileStatistics\fP & \fBoperator=\fP (\fBconst\fP \fBFileStatistics\fP &)=\fBdefault\fP"
.br
.ti -1c
.RI "\fBFileStatistics\fP (\fBFileStatistics\fP &&)=\fBdefault\fP"
.br
.ti -1c
.RI "\fBFileStatistics\fP & \fBoperator=\fP (\fBFileStatistics\fP &&)=\fBdefault\fP"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBread\fP (\fBAbstractFile\fP &\fBis\fP)"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBwrite\fP (\fBAbstractFile\fP &\fBos\fP)"
.br
.ti -1c
.RI "\fBuint32_t\fP \fBcalculateStatisticsSize\fP () \fBconst\fP"
.br
.in -1c
.SS "Public Attributes"

.in +1c
.ti -1c
.RI "\fBuint32_t\fP \fBsignature\fP {FileSignature}"
.br
.ti -1c
.RI "\fBuint32_t\fP \fBstatisticsSize\fP {\fBcalculateStatisticsSize\fP()}"
.br
.ti -1c
.RI "\fBuint32_t\fP \fBapiNumber\fP { 4080200 }"
.br
.ti -1c
.RI "\fBuint8_t\fP \fBapplicationId\fP {}"
.br
.ti -1c
.RI "\fBuint8_t\fP \fBcompressionLevel\fP {1}"
.br
.ti -1c
.RI "\fBuint8_t\fP \fBapplicationMajor\fP {}"
.br
.ti -1c
.RI "\fBuint8_t\fP \fBapplicationMinor\fP {}"
.br
.ti -1c
.RI "\fBuint64_t\fP \fBfileSize\fP {}"
.br
.ti -1c
.RI "\fBuint64_t\fP \fBuncompressedFileSize\fP {}"
.br
.ti -1c
.RI "\fBuint32_t\fP \fBobjectCount\fP {}"
.br
.ti -1c
.RI "\fBuint32_t\fP \fBapplicationBuild\fP {}"
.br
.ti -1c
.RI "\fBSYSTEMTIME\fP \fBmeasurementStartTime\fP {}"
.br
.ti -1c
.RI "\fBSYSTEMTIME\fP \fBlastObjectTime\fP {}"
.br
.ti -1c
.RI "\fBuint64_t\fP \fBrestorePointsOffset\fP {}"
.br
.ti -1c
.RI "std::array< \fBuint32_t\fP, 16 > \fBreservedFileStatistics\fP {}"
.br
.in -1c
.SH "Detailed Description"
.PP 
\fBFile\fP statistics 
.SH "Member Function Documentation"
.PP 
.SS "\fBuint32_t\fP Vector::BLF::FileStatistics::calculateStatisticsSize () const"
Calculates the statisticsSize
.PP
\fBReturns\fP
.RS 4
statistics size 
.RE
.PP

.SS "\fBvoid\fP Vector::BLF::FileStatistics::read (\fBAbstractFile\fP & is)\fR [virtual]\fP"
read file statistics
.PP
\fBParameters\fP
.RS 4
\fIis\fP input stream 
.RE
.PP

.SS "\fBvoid\fP Vector::BLF::FileStatistics::write (\fBAbstractFile\fP & os)\fR [virtual]\fP"
write file statistics
.PP
\fBParameters\fP
.RS 4
\fIos\fP output stream 
.RE
.PP

.SH "Member Data Documentation"
.PP 
.SS "\fBuint32_t\fP Vector::BLF::FileStatistics::apiNumber { 4080200 }"
BL API number
.PP
This consists of major, minor, build, patch\&. It's encoded as such: major * 1000000 + minor * 1000 + build * 100 + patch\&. Example: 4010608 decodes to 4\&.1\&.6\&.8\&. 
.SS "\fBuint32_t\fP Vector::BLF::FileStatistics::applicationBuild {}"
application build number
.PP
\fBTodo\fP
.RS 4
The BL API function takes an uint8_t argument here\&. 
.RE
.PP

.SS "\fBuint8_t\fP Vector::BLF::FileStatistics::applicationId {}"
application ID 
.SS "\fBuint8_t\fP Vector::BLF::FileStatistics::applicationMajor {}"
application major number 
.SS "\fBuint8_t\fP Vector::BLF::FileStatistics::applicationMinor {}"
application minor number 
.SS "\fBuint8_t\fP Vector::BLF::FileStatistics::compressionLevel {1}"
compression level
.PP
\fBNote\fP
.RS 4
zlib defines maximum compression level 9\&. All files that show 10 here, actually have LogContainers with compression level 6, which is default for Vector BLF\&. 
.RE
.PP

.SS "\fBuint64_t\fP Vector::BLF::FileStatistics::fileSize {}"
(compressed) file size in bytes 
.SS "\fBSYSTEMTIME\fP Vector::BLF::FileStatistics::lastObjectTime {}"
last object time 
.SS "\fBSYSTEMTIME\fP Vector::BLF::FileStatistics::measurementStartTime {}"
measurement start time 
.SS "\fBuint32_t\fP Vector::BLF::FileStatistics::objectCount {}"
number of objects 
.SS "std::array<\fBuint32_t\fP, 16> Vector::BLF::FileStatistics::reservedFileStatistics {}"
reserved 
.SS "\fBuint64_t\fP Vector::BLF::FileStatistics::restorePointsOffset {}"

.PP
\fBNote\fP
.RS 4
The following variables are based on observations, as there is no public documentation available\&. This variable designates the file position of the (first) \fBLogContainer\fP that contains the \fBRestorePointContainer\fP objects\&.
.RE
.PP
If \fBRestorePoints\fP are not used, this defaults to 0\&.
.PP
\fBSee also\fP
.RS 4
\fBRestorePointContainer\fP 
.RE
.PP

.SS "\fBuint32_t\fP Vector::BLF::FileStatistics::signature {FileSignature}"
signature (signature) 
.SS "\fBuint32_t\fP Vector::BLF::FileStatistics::statisticsSize {\fBcalculateStatisticsSize\fP()}"
sizeof(FileStatistics) 
.SS "\fBuint64_t\fP Vector::BLF::FileStatistics::uncompressedFileSize {}"
uncompressed file size in bytes 

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