Vector::BLF::MostPkt(3)

💅 NAME 💅

Vector::BLF::MostPkt — MOST_PKT. That’s the whole vibe of the name, bestie. 🫶

✨ SYNOPSIS ✨

#include <MostPkt.h>

Inherits Vector::BLF::ObjectHeader.

🌸 Public Member Functions

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

🦋 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 of message events.
• uint8_t reservedMostPkt1 {} — reserved.
• uint32_t sourceAdr {} — source address.
• uint32_t destAdr {} — target address.
• uint8_t arbitration {} — arbitration byte.
• uint8_t timeRes {} — obsolete member; read/write 0.
• uint8_t quadsToFollow {} — number of quadlets.
• uint8_t reservedMostPkt2 {} — reserved.
• uint16_t crc {} — Cyclic Redundancy Check.
• uint8_t priority {} — priority.
• uint8_t transferType {} — Tranfer type. (Yes, the label literally says “Tranfer type.”)
• uint8_t state {} — transmission state.
• uint8_t reservedMostPkt3 {} — reserved.
• uint16_t reservedMostPkt4 {} — reserved.
• uint32_t pktDataLength {} — length of variable data in bytes.
• uint32_t reservedMostPkt5 {} — reserved.
• std::vector< uint8_t > pktData {} — variable data.

💖 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 }

🔥 Detailed Description 🔥

MOST_PKT.

🚨 Warning, bestie: this event structure was never and should never be used. Use MostPkt2 instead. That’s not a drill, that’s the actual docs. 💀

🌟 Member Function Documentation 🌟

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

Calculates the objectSize.

Returns object size.

Reimplemented from Vector::BLF::ObjectHeaderBase.

---

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

Read the data of this object.

Parameters is — input stream.

Reimplemented from Vector::BLF::ObjectHeaderBase.

---

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

Write the data of this object.

Parameters os — output stream.

Reimplemented from Vector::BLF::ObjectHeaderBase.

🍓 Member Data Documentation 🍓

• uint8_t Vector::BLF::MostPkt::arbitration {} — Arbitration byte.
• uint16_t Vector::BLF::MostPkt::channel {} — application channel. And yes, the docs repeat it: Application channel.
• uint16_t Vector::BLF::MostPkt::crc {} — Cyclic Redundancy Check.
• uint32_t Vector::BLF::MostPkt::destAdr {} — Target address.
• uint8_t Vector::BLF::MostPkt::dir {} — Direction of message events:
  • 0: Rx (received)
  • 1: Tx (transmit receipt)
  • 2: Tx Request (transmit request)
• std::vector<uint8_t> Vector::BLF::MostPkt::pktData {} — variable data. The docs repeat it as: Variable data.
• uint32_t Vector::BLF::MostPkt::pktDataLength {} — length of variable data in bytes. The docs repeat it as: Length of variable data in bytes (1014 max).
• uint8_t Vector::BLF::MostPkt::priority {} — Priority.
• uint8_t Vector::BLF::MostPkt::quadsToFollow {} — Number of quadlets.
• uint8_t Vector::BLF::MostPkt::reservedMostPkt1 {} — reserved.
• uint8_t Vector::BLF::MostPkt::reservedMostPkt2 {} — reserved.
• uint8_t Vector::BLF::MostPkt::reservedMostPkt3 {} — reserved.
• uint16_t Vector::BLF::MostPkt::reservedMostPkt4 {} — reserved.
• uint32_t Vector::BLF::MostPkt::reservedMostPkt5 {} — reserved.
• uint32_t Vector::BLF::MostPkt::sourceAdr {} — Source address.
• uint8_t Vector::BLF::MostPkt::state {} — Transmission state:
  • 0 for Rx
  • 0x40 for TxOk (transmit request)
• uint8_t Vector::BLF::MostPkt::timeRes {} — Obsolete member; read/write 0.
• uint8_t Vector::BLF::MostPkt::transferType {} — Tranfer type. Message-like events can either be recorded through the MOST transceiver chip or through a separate network spy:
  • 1: Node MOST transceiver reported the message (either due to a successful reception or as acknowledgment for a transmit request).
  • 2: Spy Message was reported by the network spy. The Spy sees all messages independently of the destination address.

💌 Author 💌

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

---

That’s the whole page, bestie. 💖 Source/version: Vector BLF. Manual page: Vector::BLF::MostPkt(3). The footer doesn’t list a date, so no fake date energy here — periodt. ✨