Vector::BL...jectHeader(3)

🌈 Vector::BLF::VarObjectHeader 🌈

Manual-name moment, bestie: this is the Vector::BL...jectHeader(3) page, and it lives under Library Functions Manual. 💅

---

💖 NAME 💖

Vector::BLF::VarObjectHeader — the extended base object header type definition with dynamic extendible objects. It's giving “header but make it flexible,” periodt. ✨

---

✨ SYNOPSIS ✨

#include <VarObjectHeader.h>

Inherits Vector::BLF::ObjectHeaderBase.

🎀 Public Types 🎀

enum ObjectFlags : uint32_t { TimeTenMics = 0x00000001, TimeOneNans = 0x00000002 }

🦋 Public Member Functions 🦋

• VarObjectHeader (const ObjectType objectType)
• void read (AbstractFile &is) override
• void write (AbstractFile &os) override
• uint16_t calculateHeaderSize () const override
• uint32_t calculateObjectSize () const override

🌸 Public Member Functions inherited from Vector::BLF::ObjectHeaderBase 🌸

• ObjectHeaderBase (const uint16_t headerVersion, const ObjectType objectType)
• ObjectHeaderBase (const ObjectHeaderBase &)=default
• ObjectHeaderBase & operator= (const ObjectHeaderBase &)=default
• ObjectHeaderBase (ObjectHeaderBase &&)=default
• ObjectHeaderBase & operator= (ObjectHeaderBase &&)=default

🧚 Public Attributes 🧚

• uint32_t objectFlags {ObjectFlags::TimeOneNans} — object flags
• uint16_t objectStaticSize {} — size of the static part of the object
• uint16_t objectVersion {} — object specific version
• uint64_t objectTimeStamp {} — object timestamp

👑 Public Attributes inherited from Vector::BLF::ObjectHeaderBase 👑

• uint32_t signature {ObjectSignature} — signature (ObjectSignature)
• uint16_t headerSize {} — sizeof object header
• uint16_t headerVersion {} — header version (1)
• uint32_t objectSize {} — object size
• ObjectType objectType {ObjectType::UNKNOWN} — object type

---

💅 Detailed Description 💅

This is the extended base object header type definition, made for dynamic extendible objects. Lowkey iconic, ngl. ✨

---

🧚 Member Enumeration Documentation 🧚

🌟 enum Vector::BLF::VarObjectHeader::ObjectFlags : uint32_t 🌟

This is the enumeration for objectFlags, bestie. 🫶

• TimeTenMics — 10 micro second timestamp. The object time stamp is saved as a multiple of ten microseconds. (BL_OBJ_FLAG_TIME_TEN_MICS)
• TimeOneNans — 1 nano second timestamp. The object time stamp is saved in nanoseconds. (BL_OBJ_FLAG_TIME_ONE_NANS)

---

🔥 Member Function Documentation 🔥

🦋 uint16_t Vector::BLF::VarObjectHeader::calculateHeaderSize () const [override], [virtual]

Calculates the headerSize.

Returns header size

Reimplemented from Vector::BLF::ObjectHeaderBase.

🌈 uint32_t Vector::BLF::VarObjectHeader::calculateObjectSize () const [override], [virtual]

Calculates the objectSize.

Returns object size

Reimplemented from Vector::BLF::ObjectHeaderBase.

💜 void Vector::BLF::VarObjectHeader::read (AbstractFile & is) [override], [virtual]

Reads the data of this object.

Parameters

• is — input stream

Reimplemented from Vector::BLF::ObjectHeaderBase.

🍓 void Vector::BLF::VarObjectHeader::write (AbstractFile & os) [override], [virtual]

Writes the data of this object.

Parameters

• os — output stream

Reimplemented from Vector::BLF::ObjectHeaderBase.

---

🌸 Member Data Documentation 🌸

uint32_t Vector::BLF::VarObjectHeader::objectFlags {ObjectFlags::TimeOneNans}

object flags — unit of object timestamp. 💅

uint64_t Vector::BLF::VarObjectHeader::objectTimeStamp {}

object timestamp — time stamp of this object in the unit specified in objectFlags. 🕰️

uint16_t Vector::BLF::VarObjectHeader::objectVersion {}

object specific version — object specific version, has to be set to 0 unless stated otherwise in the description of a specific event. No cap. ⭐

---

👑 Author 👑

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

---

Later, bestie 🫶 — footer vibes: source/version Vector BLF, footer tag Vector::BL...jectHeader(3), and no separate date was shown in that footer, periodt. 💖