VECTOR_BLF_MOSTTXLIGHT(3)

📦 version 2.4.2, in arch rolling

💖 NAME 💖

Vector::BLF::MostTxLight — okay so this is the MOST_TXLIGHT class, bestie. That's the whole vibe. 🎀

(also, hi, you're reading the Library Functions Manual — welcome to the group chat ✨)

🌸 SYNOPSIS 🌸

#include <MostTxLight.h>

It inherits from Vector::BLF::ObjectHeader2. Like, that's its whole ancestry situation. 👑

✨ Public Member Functions ✨

  • void read (AbstractFile &is) override — reads stuff in
  • void write (AbstractFile &os) override — writes stuff out
  • uint32_t calculateObjectSize () const override — math time, it counts the object size

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

  • ObjectHeader2 (const ObjectType objectType) — the constructor, it's giving very "I take an object type" energy
  • 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, default, no notes
  • ObjectHeaderBase & operator= (const ObjectHeaderBase &)=default — copy assignment, also default
  • ObjectHeaderBase (ObjectHeaderBase &&)=default — move constructor, default bestie
  • ObjectHeaderBase & operator= (ObjectHeaderBase &&)=default — move assignment, default, periodt

🦋 Public Attributes 🦋

  • uint16_t channel {} — the application channel 💖
  • uint16_t state {} — the state (deets down below, keep scrolling)
  • uint32_t reservedMostTxLight {} — reserved, do not touch, it's reserved

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

  • uint32_t objectFlags {ObjectFlags::TimeOneNans} — object flags, and yes the default is literally TimeOneNans
  • uint8_t timeStampStatus {} — time stamp status
  • uint8_t reservedObjectHeader {0} — reserved, defaulting to 0
  • uint16_t objectVersion {0} — object specific version, starting at 0
  • uint64_t objectTimeStamp {0} — object timestamp, 0
  • uint64_t originalTimeStamp {0} — the original object timestamp, also 0

🎀 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, defaults to UNKNOWN (mystery era 🕵️)

⭐ Additional Inherited Members ⭐

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

  • enum ObjectFlags : uint32_t — { TimeTenMics = 0x00000001, TimeOneNans = 0x00000002 } — two whole flags, iconic
  • enum TimeStampStatus : uint8_t — { Orig = 0x01, SwHw = 0x02, User = 0x10 } — three statuses, no cap

🌸 Detailed Description 🌸

MOST_TXLIGHT. That's the name, that's the energy. 💅

So like, depending on which physical layer you're on:

  • Optical physical layer: Information about light output of the Fiber Optical Transmitter
  • Electrical physical layer: Signal output state

Both of those are literally the definition, I'm not making it up 💖

🧚 Member Function Documentation 🧚

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

Calculates the objectSize. bestie it's doing math for you so you don't have to 🧮✨

Returns — object size

Reimplemented from Vector::BLF::ObjectHeaderBase.

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

Read the data of this object. Slurp it in 📥

Parameters

  • is — input stream

Reimplemented from Vector::BLF::ObjectHeaderBase.

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

Write the data of this object. Bloop it out 📤

Parameters

  • os — output stream

Reimplemented from Vector::BLF::ObjectHeaderBase.

💜 Member Data Documentation 💜

🌟 uint16_t Vector::BLF::MostTxLight::channel {}

application channel — Application channel. (yes she said it twice, the docs said it twice, I'm not editing the queen 💅)

🌟 uint32_t Vector::BLF::MostTxLight::reservedMostTxLight {}

reserved. that's it. that's the note. don't ask. 🙈

🌟 uint16_t Vector::BLF::MostTxLight::state {}

The state values, and this part actually matters so pay attention 👑

  • 0 – TxLight/Signal off
  • 1 – TxLight/Signal enabled
  • 2 – TxLight/Signal forced on
lowkey important: 0 is off, 1 is enabled, 2 is forced on. three options, no more, no cap.

👑 Author 👑

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

okay that's the whole page bestie, hope it slayed 💖✨🎀🦋🌸💅🫶

— sign-off from the Vector BLF girlies: this was Vector::BLF::MostTxLight(3), served fresh from the Vector BLF source and date stamp, mwah 😘💜

📦 where this page comes from