Vector::BL...ystemEvent(3)

📦 version 2.4.2, in arch rolling

okay bestie, welcome to the Vector::BL...ystemEvent(3) page from the Library Functions Manual — we're decoding this header-file icon together, and yes, it's giving object-header main-character energy 💅✨

💖 NAME 💖

Vector::BLF::MostSystemEvent — MOST_SYSTEM_EVENT. That's the whole name, no cap. 🫶

🦋 SYNOPSIS 🦋

Here's the include and the inheritance tea:

#include <MostSystemEvent.h>

It inherits Vector::BLF::ObjectHeader2 — yup, exact.

✨ Public Member Functions ✨

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

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

  • ObjectHeader2 (const ObjectType objectType) — constructor, taking the object type.
  • void read (AbstractFile &is) override — inherited read override.
  • void write (AbstractFile &os) override — inherited write override.
  • uint16_t calculateHeaderSize () const override — inherited header-size calculator.
  • uint32_t calculateObjectSize () const override — inherited object-size calculator.

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

  • ObjectHeaderBase (const uint16_t headerVersion, const ObjectType objectType) — constructor with header version and object type.
  • ObjectHeaderBase (const ObjectHeaderBase &)=default — copy constructor, defaulted.
  • ObjectHeaderBase & operator= (const ObjectHeaderBase &)=default — copy assignment, defaulted.
  • ObjectHeaderBase (ObjectHeaderBase &&)=default — move constructor, defaulted.
  • ObjectHeaderBase & operator= (ObjectHeaderBase &&)=default — move assignment, defaulted.

💜 Public Attributes 💜

  • uint16_t channel {} — comment says application channel; this is the application channel.
  • uint16_t id {} — comment says identifier of transported data; it's the identifier of transported data.
  • uint32_t value {} — comment says current value; this is the current value.
  • uint32_t valueOld {} — comment says previous value; this is the previous value.
  • uint32_t reservedMostSystemEvent {} — no extra comment on the page for this one, bestie.

🦋 Public Attributes inherited from Vector::BLF::ObjectHeader2 🦋

  • uint32_t objectFlags {ObjectFlags::TimeOneNans} — comment says object flags.
  • uint8_t timeStampStatus {} — comment says time stamp status.
  • uint8_t reservedObjectHeader {0} — no extra comment on the page.
  • uint16_t objectVersion {0} — comment says object specific version.
  • uint64_t objectTimeStamp {0} — comment says object timestamp.
  • uint64_t originalTimeStamp {0} — comment says original object timestamp.

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

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

👑 Additional Inherited Members 👑

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

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

enum TimeStampStatus : uint8_t { Orig = 0x01, SwHw = 0x02, User = 0x10 }

✨ Detailed Description ✨

MOST_SYSTEM_EVENT. That's the banner. Under it: "Event for various system states." — cute, concise, and exactly what the page says. 🦋

🌸 Member Function Documentation 🌸

💅 uint32_t Vector::BLF::MostSystemEvent::calculateObjectSize () const

Flags on the page: [override], [virtual]. It calculates the objectSize.

Returns: object size.

Reimplemented from Vector::BLF::ObjectHeaderBase.

💖 void Vector::BLF::MostSystemEvent::read (AbstractFile & is)

Flags on the page: [override], [virtual]. Read the data of this object.

Parameters: is — input stream.

Reimplemented from Vector::BLF::ObjectHeaderBase.

💜 void Vector::BLF::MostSystemEvent::write (AbstractFile & os)

Flags on the page: [override], [virtual]. Write the data of this object.

Parameters: os — output stream.

Reimplemented from Vector::BLF::ObjectHeaderBase.

🎀 Member Data Documentation 🎀

🍓 uint16_t Vector::BLF::MostSystemEvent::channel {}

Comment: application channel. Description: Application channel.

🍓 uint16_t Vector::BLF::MostSystemEvent::id {}

Comment: identifier of transported data. Description: Identification of transported data (enumeration):

  • 1 — System Lock (MOST150)
  • 2 — Shutdown Flag (MOST150)
  • 3 — Shutdown Reason (MOST150)

🍓 uint32_t Vector::BLF::MostSystemEvent::reservedMostSystemEvent {}

Description: reserved.

🍓 uint32_t Vector::BLF::MostSystemEvent::value {}

Comment: current value. Description: Current value.

🍓 uint32_t Vector::BLF::MostSystemEvent::valueOld {}

Comment: previous value. Description: Previous value.

👑 Author 👑

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

okay that's the whole manual page, bestie 🫶 — source/version: Vector BLF; footer date: no separate calendar date is shown, just Vector::BL...ystemEvent(3) in the footer spot. Bye, slay, and may your object sizes calculate correctly 💖✨

📦 where this page comes from