Vector::BLF::A429Status(3)

📦 version 2.4.2, in arch rolling

💅 NAME 💅

Okay so bestie, welcome to the Vector::BLF::A429Status(3) manual page from the Library Functions Manual. The name is Vector::BLF::A429Status — A429_STATUS. That's the whole name section, and honestly? Clean. ✨

🌈 SYNOPSIS 🌈

Include it like this, no cap:

#include <A429Status.h>

And the inheritance situation: this class inherits Vector::BLF::ObjectHeader.

🫶 Public Member Functions 🫶

  • void read (AbstractFile &is) override — reads the object data from an input stream.
  • void write (AbstractFile &os) override — writes the object data to an output stream.
  • uint32_t calculateObjectSize () const override — calculates the object size.

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

  • ObjectHeader (const ObjectType objectType, const uint16_t objectVersion=0)
  • 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
  • ObjectHeaderBase & operator= (const ObjectHeaderBase &)=default
  • ObjectHeaderBase (ObjectHeaderBase &&)=default
  • ObjectHeaderBase & operator= (ObjectHeaderBase &&)=default

🎀 Public Attributes 🎀

  • uint16_t channel {} — application channel.
  • uint8_t dir {} — direction flag: 0=Rx, 1=Tx.
  • uint8_t reservedA429Status1 {} — reserved.
  • uint16_t parity {} — parity.
  • uint16_t reservedA429Status2 {} — reserved.
  • uint32_t minGap {} — minimum gap.
  • uint32_t bitrate {} — Tx bit rate.
  • uint32_t minBitrate {} — Rx min bit rate.
  • uint32_t maxBitrate {} — Rx max bit rate.

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

  • uint32_t objectFlags {ObjectFlags::TimeOneNans} — object flags
  • uint16_t clientIndex {} — client index of send node
  • uint16_t objectVersion {0} — object specific version
  • 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 (1)
  • uint32_t objectSize {} — object size
  • ObjectType objectType {ObjectType::UNKNOWN} — object type

🌸 Additional Inherited Members 🌸

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

  • enum ObjectFlags : uint32_t { TimeTenMics = 0x00000001, TimeOneNans = 0x00000002 } — yep, those are the enum values, exactly as listed.

🔥 Detailed Description 🔥

The description is literally A429_STATUS. Then it says: A429 status object. That's the whole vibe: it's the A429 status object, doing exactly what it says on the tin. 💖

🛠️ Member Function Documentation 🛠️

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

Calculates the objectSize.

Returns: object size.

Reimplemented from Vector::BLF::ObjectHeaderBase.

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

Read the data of this object.

Parameters:

  • is — input stream.

Reimplemented from Vector::BLF::ObjectHeaderBase.

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

Write the data of this object.

Parameters:

  • os — output stream.

Reimplemented from Vector::BLF::ObjectHeaderBase.

🍓 Member Data Documentation 🍓

All the fields, bestie:

  • uint32_t Vector::BLF::A429Status::bitrate {} — Tx bit rate
  • uint16_t Vector::BLF::A429Status::channel {} — application channel
  • uint8_t Vector::BLF::A429Status::dir {} — direction flag: 0=Rx, 1=Tx
  • uint32_t Vector::BLF::A429Status::maxBitrate {} — Rx max bit rate
  • uint32_t Vector::BLF::A429Status::minBitrate {} — Rx min bit rate
  • uint32_t Vector::BLF::A429Status::minGap {} — minimum gap
  • uint16_t Vector::BLF::A429Status::parity {} — parity
  • uint8_t Vector::BLF::A429Status::reservedA429Status1 {} — reserved
  • uint16_t Vector::BLF::A429Status::reservedA429Status2 {} — reserved

🧚 Author 🧚

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

Okay final footer energy: source/version is Vector BLF, the page is Vector::BLF::A429Status(3), and the footer in this copy has no date — so I'm not inventing one, bestie. Bye 💅✨

📦 where this page comes from