VECTOR_BLF_EVENTCOMMENT(3)

✨ NAME ✨

Vector::BLF::EventComment — EVENT_COMMENT. This is the Vector::BL...ventComment(3) page from the Library Functions Manual, and yes bestie, it's giving C++ BLF object realness 💅

🌸 SYNOPSIS 🌸

#include <EventComment.h>

Inherits Vector::BLF::ObjectHeader — family tree realness.

🫶 Public Member Functions

• void read (AbstractFile &is) override
• void write (AbstractFile &os) override
• uint32_t calculateObjectSize () const override

💜 Public Member Functions inherited from Vector::BLF::ObjectHeader

• ObjectHeader (const ObjectType objectType, const uint16_t objectVersion=0)
• 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 commentedEventType {} — commented event type
• uint32_t textLength {} — text length in bytes
• uint64_t reservedEventComment {}
• std::string text {} — text in MBCS

🌈 Public Attributes inherited from Vector::BLF::ObjectHeader

• uint32_t objectFlags {ObjectFlags::TimeOneNans} — object flags
• uint16_t clientIndex {} — client index of send node
• uint16_t objectVersion {0} — 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

👑 Additional Inherited Members

🧚 Public Types inherited from Vector::BLF::ObjectHeader

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

💖 Detailed Description 💖

EVENT_COMMENT.

Comment of an event. The comment can be set in Trace Window.

🔥 Member Function Documentation 🔥

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

Calculates the objectSize — size math era.

Returns: object size.

Reimplemented from Vector::BLF::ObjectHeaderBase.

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

Read the data of this object — read mode activated.

Parameters: is input stream.

Reimplemented from Vector::BLF::ObjectHeaderBase.

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

Write the data of this object — write mode activated.

Parameters: os output stream.

Reimplemented from Vector::BLF::ObjectHeaderBase.

🍓 Member Data Documentation 🍓

uint32_t Vector::BLF::EventComment::commentedEventType {}

commented event type — Type of the commented event.

uint64_t Vector::BLF::EventComment::reservedEventComment {}

reserved.

std::string Vector::BLF::EventComment::text {}

text in MBCS — Comment text.

uint32_t Vector::BLF::EventComment::textLength {}

text length in bytes — Length of text without ending 0.

✨ Author ✨

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

---

cute sign-off: source/version is Vector BLF, page is Vector::BL...ventComment(3), and the date slot in the original footer is not shown — so no invented date, bestie 😭💖