VECTOR_BLF_COMPACTSERIALEVENT(3)

📦 version 2.4.2, in arch rolling

okay so this is the page for Vector::BL...SerialEvent(3) from the Library Functions Manual — yes, the title is literally truncated like that on the page, and the class it's actually about is Vector::BLF::CompactSerialEvent. Buckle up, bestie 🫶

🌸 NAME 🌸

Vector::BLF::CompactSerialEvent — the compact serial event class, periodt.

✨ SYNOPSIS ✨

Include it like this, no cap:

#include <CompactSerialEvent.h>

💖 Public Member Functions 💖

  • CompactSerialEvent (const CompactSerialEvent &)=default — copy constructor, defaulted, slay.
  • CompactSerialEvent & operator= (const CompactSerialEvent &)=default — copy assignment operator, also defaulted.
  • CompactSerialEvent (CompactSerialEvent &&)=default — move constructor, defaulted.
  • CompactSerialEvent & operator= (CompactSerialEvent &&)=default — move assignment operator, defaulted.
  • virtual void read (AbstractFile &is) — reads the data of this object.
  • virtual void write (AbstractFile &os) — writes the data of this object.
  • virtual uint32_t calculateObjectSize () const — calculates the object size.

🎀 Public Attributes 🎀

  • uint8_t compactLength {} — compact length.
  • std::array< uint8_t, 15 > compactData {} — compact data.

🦋 Detailed Description 🦋

compact serial event — that's the whole detailed description. Short, sweet, iconic.

🔥 Member Function Documentation 🔥

💫 uint32_t Vector::BLF::CompactSerialEvent::calculateObjectSize () const 💫

[virtual]

Calculates the objectSize.

Returns: object size.

📖 void Vector::BLF::CompactSerialEvent::read (AbstractFile & is) 📖

[virtual]

Read the data of this object.

Parameters:

  • is — input stream.

📝 void Vector::BLF::CompactSerialEvent::write (AbstractFile & os) 📝

[virtual]

Write the data of this object.

Parameters:

  • os — output stream.

🍓 Member Data Documentation 🍓

🧺 std::array<uint8_t, 15> Vector::BLF::CompactSerialEvent::compactData {} 🧺

compact data.

📏 uint8_t Vector::BLF::CompactSerialEvent::compactLength {} 📏

compact length.

👑 Author 👑

Generated automatically by Doxygen for Vector BLF from the source code. No cap, that's the author section.

okay that's the page 💜 — source/version: Vector BLF; date: the footer doesn't print one, so no invented date from me; the footer also echoes Vector::BL...SerialEvent(3). bye bestie 🎀

📦 where this page comes from