Vector::BLF::MostStress(3)

okay bestie, welcome to the Vector::BLF::MostStress(3) page from the Library Functions Manual for Vector BLF 💖 We're about to get into the MOST_STRESS object, and it is literally giving hardware-stress-info realness. Every inherited member is coming with us, no cap ✨

💖 NAME 💖

Vector::BLF::MostStress — MOST_STRESS. That's the name, periodt 🫶

🦋 SYNOPSIS 🦋

#include <MostStress.h>

Inherits Vector::BLF::ObjectHeader2.

✨ Public Member Functions ✨

• void read (AbstractFile &is) override — reads this object's data from the input stream.
• void write (AbstractFile &os) override — writes this object's data to the output stream.
• uint32_t calculateObjectSize () const override — calculates the object size and returns it as a uint32_t.

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

• ObjectHeader2 (const ObjectType objectType) — constructor that takes the object type.
• void read (AbstractFile &is) override — inherited read.
• void write (AbstractFile &os) override — inherited write.
• 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 — defaulted copy constructor.
• ObjectHeaderBase & operator= (const ObjectHeaderBase &)=default — defaulted copy assignment.
• ObjectHeaderBase (ObjectHeaderBase &&)=default — defaulted move constructor.
• ObjectHeaderBase & operator= (ObjectHeaderBase &&)=default — defaulted move assignment.

🎀 Public Attributes 🎀

• uint16_t channel {} — application channel. The original literally says application channel Application channel, and we are keeping that iconic repetition 💅
• uint16_t state {} — state of Stress mode; full value list is down in Member Data Documentation.
• uint16_t mode {} — Stress mode of the HW interface; full value list is also below.
• uint16_t reservedMostStress {} — reserved. That's it. The reserved vibes are reserved 🙈

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

• uint32_t objectFlags {ObjectFlags::TimeOneNans} — object flags.
• uint8_t timeStampStatus {} — time stamp status.
• uint8_t reservedObjectHeader {0} — reserved object header.
• uint16_t objectVersion {0} — object specific version.
• uint64_t objectTimeStamp {0} — object timestamp.
• uint64_t originalTimeStamp {0} — original 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 (1).
• uint32_t objectSize {} — object size.
• ObjectType objectType {ObjectType::UNKNOWN} — 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_STRESS.

It's literally information about Stress activity of the hardware interface. That's the whole point, and it's eating 💅

🌸 Member Function Documentation 🌸

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

Calculates the objectSize.

Returns: object size.

Reimplemented from Vector::BLF::ObjectHeaderBase.

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

Read the data of this object.

Parameters: is — input stream.

Reimplemented from Vector::BLF::ObjectHeaderBase.

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

Write the data of this object.

Parameters: os — output stream.

Reimplemented from Vector::BLF::ObjectHeaderBase.

🎀 Member Data Documentation 🎀

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

application channel Application channel — yes, the original repeats it, and we are not erasing the repetition. It's the application channel 💖

🍓 uint16_t Vector::BLF::MostStress::mode {} 🍓

Stress mode of HW interface:

• 1 – Light
• 2 – Lock
• 3 – Busload Ctrl
• 4 – Busload Async
• 5 – Rx Buffer Ctrl
• 6 – TxLight power
• 7 – Bypass toggling
• 8 – SystemLock flag usage
• 9 – Shutdown flag usage
• 10 – Rx Buffer Async

🍓 uint16_t Vector::BLF::MostStress::reservedMostStress {} 🍓

reserved. That's the whole description, bestie 🙈

🍓 uint16_t Vector::BLF::MostStress::state {} 🍓

State of Stress mode:

• 0 – Stopped
• 1 – Started

💅 Author 💅

Generated automatically by Doxygen for Vector BLF from the source code. The robots wrote this one 😭

cute sign-off: source/version is Vector BLF, the page is Vector::BLF::MostStress(3), and the footer doesn't list a date — so that's the whole footer vibe, bestie. Bye 🫶💖