VECTOR_BLF_GENERALSERIALEVENT(3)

📦 version 2.4.2, in arch rolling

💅 Vector::BLF::GeneralSerialEvent 💅

okay so bestie, welcome to the Library Functions Manual page for Vector::BLF::GeneralSerialEvent. The abbreviated page header is Vector::BL...SerialEvent(3) — yes, that's literally the header, and I'm folding it in here instead of copying the whole line. This class is giving general serial event realness. Let's go. ✨

🌸 NAME 🌸

Vector::BLF::GeneralSerialEvent — that's the class name, periodt. 💅

🎀 SYNOPSIS 🎀

First up, the include. No cap, you need this exact line:

#include <GeneralSerialEvent.h>

💖 Public Member Functions 💖

Here are the public member functions, copied exactly because we do not mess with signatures:

GeneralSerialEvent (const GeneralSerialEvent &)=default
GeneralSerialEvent & operator= (const GeneralSerialEvent &)=default
GeneralSerialEvent (GeneralSerialEvent &&)=default
GeneralSerialEvent & operator= (GeneralSerialEvent &&)=default
virtual void read (AbstractFile &is)
virtual void write (AbstractFile &os)
virtual uint32_t calculateObjectSize () const

🌸 Public Attributes 🌸

These are the public attributes, with their default empty braces {} and everything:

  • uint32_t dataLength {} — length of variable data in bytes
  • uint32_t timeStampsLength {} — length of variable timestamps in bytes
  • uint64_t reservedGeneralSerialEvent {} — reserved
  • std::vector< uint8_t > data {} — variable data
  • std::vector< int64_t > timeStamps {} — variable timestamps (optional)

🦋 Detailed Description 🦋

general serial event. That's the whole description, bestie — it's a general serial event. 🦋

✨ Member Function Documentation ✨

⭐ uint32_t Vector::BLF::GeneralSerialEvent::calculateObjectSize () const [virtual] ⭐

Calculates the objectSize.

Returns: object size.

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

Read the data of this object.

Parameters: is — input stream.

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

Write the data of this object.

Parameters: os — output stream.

🍓 Member Data Documentation 🍓

  • std::vector<uint8_t> Vector::BLF::GeneralSerialEvent::data {} — variable data, and yeah, the original says it again: variable data.
  • uint32_t Vector::BLF::GeneralSerialEvent::dataLength {} — length of variable data in bytes, repeated by the docs as: length of variable data in bytes.
  • uint64_t Vector::BLF::GeneralSerialEvent::reservedGeneralSerialEvent {} — reserved.
  • std::vector<int64_t> Vector::BLF::GeneralSerialEvent::timeStamps {} — variable timestamps (optional), and again: variable timestamps (optional).
  • uint32_t Vector::BLF::GeneralSerialEvent::timeStampsLength {} — length of variable timestamps in bytes, repeated as: length of variable timestamps in bytes.

👑 Author 👑

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

okay that's the page, bestie. The footer's source/version is Vector BLF, and it repeats the abbreviated page title Vector::BL...SerialEvent(3); no date is shown on this one, ngl. It's the Library Functions Manual, and we're done. mwah 💋✨🫶

📦 where this page comes from