VECTOR_BLF_FUNCTIONBUS(3)

📦 version 2.4.2, in arch rolling

💅 NAME 💅

Vector::BLF::FunctionBus — bestie, this is the FUNCTION_BUS class. That's it. That's the whole name. Periodt. ✨

Oh and real quick, before we dive in — this whole page lives in the Library Functions Manual, section 3, okay? Just so you know where you are. 🫶

🎀 SYNOPSIS 🎀

#include <FunctionBus.h>

Lowkey the most important line: this class inherits Vector::BLF::ObjectHeader. Keep that in your back pocket, because a lot of stuff is gonna come from up there. 👑

✨ Public Types ✨

  • enum FunctionBusObjectType : uint32_t { Undefined = 0, Signal = 1, ServiceFunction = 2, State = 3 } — no cap, these are literally the four flavors. Undefined is 0, Signal is 1, ServiceFunction is 2, State is 3. 🌸

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

  • enum ObjectFlags : uint32_t { TimeTenMics = 0x00000001, TimeOneNans = 0x00000002 } — TimeTenMics is 0x00000001, TimeOneNans is 0x00000002. Slay. ⭐

💖 Public Member Functions 💖

  • void read (AbstractFile &is) override — reads stuff in, we'll get to it.
  • void write (AbstractFile &os) override — writes stuff out, also getting to it.
  • uint32_t calculateObjectSize () const override — does math for the size. Iconic behavior.

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

  • ObjectHeader (const ObjectType objectType, const uint16_t objectVersion=0) — constructor, note the objectVersion=0 default, she's got a fallback.
  • 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 — copy constructor, defaulted, she's chill like that.
  • ObjectHeaderBase & operator= (const ObjectHeaderBase &)=default — copy assignment, also defaulted.
  • ObjectHeaderBase (ObjectHeaderBase &&)=default — move constructor, defaulted, moving on up.
  • ObjectHeaderBase & operator= (ObjectHeaderBase &&)=default — move assignment, defaulted too. We love a complete set. 💜

🍓 Public Attributes 🍓

  • uint32_t functionBusObjectType {}
  • uint32_t veType {}
  • uint32_t nameLength {}
  • uint32_t dataLength {}
  • std::string name {}
  • std::vector< uint8_t > data {}

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

  • uint32_t objectFlags {ObjectFlags::TimeOneNans} — object flags (defaults to ObjectFlags::TimeOneNans, cute).
  • uint16_t clientIndex {} — client index of send node.
  • uint16_t objectVersion {0} — object specific version, starts at 0.
  • 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, and it's 1.
  • uint32_t objectSize {} — object size.
  • ObjectType objectType {ObjectType::UNKNOWN} — object type, defaults to ObjectType::UNKNOWN.

🌸 Detailed Description 🌸

FUNCTION_BUS. That's the whole vibe check, bestie. Literally that. 💅

🔥 Member Enumeration Documentation 🔥

enum Vector::BLF::FunctionBus::FunctionBusObjectType : uint32_t

It's the enumeration for functionBusObjectType, iykyk. The four values are up there in Public Types — go peek. 🙈

⭐ Member Function Documentation ⭐

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

Calculates the objectSize. Queen of arithmetic. 👑

Returns

  • the object size 🌈

Reimplemented from Vector::BLF::ObjectHeaderBase.

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

Read the data of this object. Get that info in there. 📥

Parameters

  • is — input stream

Reimplemented from Vector::BLF::ObjectHeaderBase.

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

Write the data of this object. Push it out into the world, main character energy. 📤

Parameters

  • os — output stream

Reimplemented from Vector::BLF::ObjectHeaderBase.

🎀 Member Data Documentation 🎀

  • std::vector<uint8_t> Vector::BLF::FunctionBus::data {} — variable data. (Yeah, that's exactly what it says. Vague but honest. 💀)
  • uint32_t Vector::BLF::FunctionBus::dataLength {} — length of variable data in bytes.
  • uint32_t Vector::BLF::FunctionBus::functionBusObjectType {} — type of system variable.
  • std::string Vector::BLF::FunctionBus::name {} — path name in the port server. Fancy. ✨
  • uint32_t Vector::BLF::FunctionBus::nameLength {} — length of variable name in bytes.

🦋 Author 🦋

Generated automatically by Doxygen for Vector BLF from the source code. Not a human, not a vibe, just a robot doing its thing. 🤖💖

Ngl bestie, this page was auto-generated, so if something looks terse, blame Doxygen, not me. 🫶

That's the whole page!! Courtesy of Vector BLF — the Library Functions Manual, section 3, Vector::BLF::FunctionBus(3), served fresh. Kisses, study hard, and may your objectSize always be calculated correctly. 💅✨🎀

📦 where this page comes from