VECTOR_BLF_FILESTATISTICS(3)

💖 NAME 💖

okay bestie, this is Vector::BLF::FileStatistics — yes, that's the title — and we're in the Library Functions Manual (manual name folded in near the top like a little name tag 🫶). The short story? File statistics. That's it. The name ate, no cap. 💅

---

🌈 SYNOPSIS 🌈

Include this, exactly:

#include <FileStatistics.h>

🎀 Public Member Functions 🎀

• FileStatistics (const FileStatistics &)=default — copy constructor, defaulted. iconic.
• FileStatistics & operator= (const FileStatistics &)=default — copy assignment, defaulted. slay.
• FileStatistics (FileStatistics &&)=default — move constructor, defaulted. we love a low-effort queen.
• FileStatistics & operator= (FileStatistics &&)=default — move assignment, defaulted. periodt.
• virtual void read (AbstractFile &is) — read file statistics; takes is, the input stream.
• virtual void write (AbstractFile &os) — write file statistics; takes os, the output stream.
• uint32_t calculateStatisticsSize () const — calculates the statisticsSize; returns the statistics size.

🦋 Public Attributes 🦋

• uint32_t signature {FileSignature} — signature; default is FileSignature.
• uint32_t statisticsSize {calculateStatisticsSize()} — the statistics size, defaulted via calculateStatisticsSize(); its detail-doc one-liner is sizeof(FileStatistics).
• uint32_t apiNumber { 4080200 } — BL API number; default 4080200.
• uint8_t applicationId {} — application ID; default {}.
• uint8_t compressionLevel {1} — compression level; default 1, with a zlib note below.
• uint8_t applicationMajor {} — application major number; default {}.
• uint8_t applicationMinor {} — application minor number; default {}.
• uint64_t fileSize {} — (compressed) file size in bytes; default {}.
• uint64_t uncompressedFileSize {} — uncompressed file size in bytes; default {}.
• uint32_t objectCount {} — number of objects; default {}.
• uint32_t applicationBuild {} — application build number; default {}, and there's a Todo below.
• SYSTEMTIME measurementStartTime {} — measurement start time; default {}.
• SYSTEMTIME lastObjectTime {} — last object time; default {}.
• uint64_t restorePointsOffset {} — default {}; the big observation note is below.
• std::array< uint32_t, 16 > reservedFileStatistics {} — reserved; default {}.

---

✨ Detailed Description ✨

File statistics. Literally the detailed description is File statistics, and the class is doing exactly what it says on the tin. Main character energy for a stats block. 👑

---

🧁 Member Function Documentation 🧁

uint32_t Vector::BLF::FileStatistics::calculateStatisticsSize () const

Calculates the statisticsSize.

Returns: statistics size.

void Vector::BLF::FileStatistics::read (AbstractFile & is) [virtual]

read file statistics.

Parameters: is input stream.

void Vector::BLF::FileStatistics::write (AbstractFile & os) [virtual]

write file statistics.

Parameters: os output stream.

---

🍓 Member Data Documentation 🍓

uint32_t Vector::BLF::FileStatistics::apiNumber { 4080200 }

BL API number.

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.

uint32_t Vector::BLF::FileStatistics::applicationBuild {}

application build number

Todo: The BL API function takes an uint8_t argument here.

uint8_t Vector::BLF::FileStatistics::applicationId {}

application ID

uint8_t Vector::BLF::FileStatistics::applicationMajor {}

application major number

uint8_t Vector::BLF::FileStatistics::applicationMinor {}

application minor number

uint8_t Vector::BLF::FileStatistics::compressionLevel {1}

compression level

Note: 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.

uint64_t Vector::BLF::FileStatistics::fileSize {}

(compressed) file size in bytes

SYSTEMTIME Vector::BLF::FileStatistics::lastObjectTime {}

last object time

SYSTEMTIME Vector::BLF::FileStatistics::measurementStartTime {}

measurement start time

uint32_t Vector::BLF::FileStatistics::objectCount {}

number of objects

std::array<uint32_t, 16> Vector::BLF::FileStatistics::reservedFileStatistics {}

reserved

uint64_t Vector::BLF::FileStatistics::restorePointsOffset {}

Note: The following variables are based on observations, as there is no public documentation available. This variable designates the file position of the (first) LogContainer that contains the RestorePointContainer objects. If RestorePoints are not used, this defaults to 0. See also: RestorePointContainer

uint32_t Vector::BLF::FileStatistics::signature {FileSignature}

signature — the original calls it signature (signature), and I'm keeping that little echo exactly.

uint32_t Vector::BLF::FileStatistics::statisticsSize {calculateStatisticsSize()}

sizeof(FileStatistics)

uint64_t Vector::BLF::FileStatistics::uncompressedFileSize {}

uncompressed file size in bytes

---

🫶 Author 🫶

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

okay that's the whole page — footer sign-off tea: source/version vibe is Vector BLF, and the date isn't shown on this page, so no invented date, periodt. 💅💖