VECTOR_BLF_ATTRIBUTEEVENT(3)

💖 Vector::BLF::AttributeEvent 💖

Okay bestie, this is the Vector::BLF::AttributeEvent page from the Library Functions Manual, and the page tag is Vector::BL...ributeEvent(3). Let’s get into it ✨

---

🌸 NAME 🌸

Vector::BLF::AttributeEvent — that’s the name block, no extra summary in the source page. 🎀

---

💅 SYNOPSIS 💅

Inherits Vector::BLF::ObjectHeader.

✨ Public Member Functions ✨

• void read (AbstractFile &is) override — reads this object’s data.
• void write (AbstractFile &os) override — writes this object’s data.
• uint32_t calculateObjectSize () const override — calculates the object size.

🦋 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 mainAttributableObjectPathLength — length of variable mainAttributableObjectPath in bytes.
• uint32_t memberPathLength — length of variable memberPath in bytes.
• uint32_t attributeDefinitionPathLength — length of variable attributeDefinitionPath in bytes.
• uint32_t dataLength — length of variable data in bytes.
• std::string mainAttributableObjectPath — path of the main attributable object.
• std::string memberPath — path of the member (optional).
• std::string attributeDefinitionPath — path of the attribute definition.
• std::vector< uint8_t > data — variable data.

🌟 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 } — the ObjectFlags enum, with those exact values.

---

🔥 Member Function Documentation 🔥

uint32_t Vector::BLF::AttributeEvent::calculateObjectSize () const

Tags: [override], [virtual]

Calculates the objectSize.

Returns: object size.

Reimplemented from Vector::BLF::ObjectHeaderBase.

---

void Vector::BLF::AttributeEvent::read (AbstractFile & is)

Tags: [override], [virtual]

Read the data of this object.

Parameters: is input stream.

Reimplemented from Vector::BLF::ObjectHeaderBase.

---

void Vector::BLF::AttributeEvent::write (AbstractFile & os)

Tags: [override], [virtual]

Write the data of this object.

Parameters: os output stream.

Reimplemented from Vector::BLF::ObjectHeaderBase.

---

🫶 AUTHOR 🫶

Generated automatically by Doxygen for Vector BLF from the source code. So yeah, the author line is literally the autogen icon doing its thing 💅

---

Sign-off bestie: source/version is Vector BLF, the footer page tag is Vector::BL...ributeEvent(3), and the original footer didn’t print a date — Doxygen just autogenerated and dipped. 🧚💜✨