Vector::BLF::MostPkt2(3)

πŸ“¦ version 2.4.2, in arch rolling

πŸ’– Vector::BLF::MostPkt2(3) πŸ’–

okay bestie, so this is a page from the Library Functions Manual and it's all about Vector::BLF::MostPkt2, which isβ€”say it with meβ€”MOST_PKT2. iconic name, no notes. ✨


πŸŽ€ NAME πŸŽ€

Vector::BLF::MostPkt2 β€” literally just MOST_PKT2. that's the whole name. slay.


✨ SYNOPSIS ✨

#include <MostPkt2.h>

she Inherits from Vector::BLF::ObjectHeader2. family tree matters, bestie 🌸

πŸ’… Public Member Functions

void read (AbstractFile &is) override
void write (AbstractFile &os) override
uint32_t calculateObjectSize () const override

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

ObjectHeader2 (const ObjectType objectType)
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

like, four whole defaulted special members? she's lowkey just vibing and letting the compiler do the work. periodt.

πŸ“ Public Attributes

  • uint16_t channel {} β€” application channel
  • uint8_t dir {}
  • uint8_t reservedMostPkt1 {}
  • uint32_t sourceAdr {}
  • uint32_t destAdr {}
  • uint8_t arbitration {}
  • uint8_t timeRes {}
  • uint8_t quadsToFollow {}
  • uint8_t reservedMostPkt2 {}
  • uint16_t crc {}
  • uint8_t priority {}
  • uint8_t transferType {} β€” Tranfer Type. (yes that's how it's spelled in the source, i'm not fixing it, it's canon 😭)
  • uint8_t state {}
  • uint8_t reservedMostPkt3 {}
  • uint16_t reservedMostPkt4 {}
  • uint32_t pktDataLength {} β€” length of variable data in bytes
  • uint32_t reservedMostPkt5 {}
  • std::vector< uint8_t > pktData {} β€” variable data

πŸ‘‘ Public Attributes inherited from Vector::BLF::ObjectHeader2

  • uint32_t objectFlags {ObjectFlags::TimeOneNans} β€” object flags
  • uint8_t timeStampStatus {} β€” time stamp status
  • uint8_t reservedObjectHeader {0}
  • 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 }

look at those enum values, bestie. 0x01, 0x02, 0x10. hex girl summer πŸ”₯


🌸 Detailed Description 🌸

MOST_PKT2.

Message on MOST25 Packet Data Channel. that's the whole vibe check, and she passed βœ…


⭐ Member Function Documentation ⭐

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

Calculates the objectSize.

Returns object size

Reimplemented from Vector::BLF::ObjectHeaderBase. she said "i'll do it myself" πŸ’…

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

Read the data of this object.

Parameters is β€” input stream

Reimplemented from Vector::BLF::ObjectHeaderBase.

void Vector::BLF::MostPkt2::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::MostPkt2::arbitration {} β€” Arbitration byte
  • uint16_t Vector::BLF::MostPkt2::channel {} β€” application channel Application channel
  • uint16_t Vector::BLF::MostPkt2::crc {} β€” Cyclic Redundancy Check
  • uint32_t Vector::BLF::MostPkt2::destAdr {} β€” Target address
  • uint8_t Vector::BLF::MostPkt2::dir {} β€” Direction of message events:
    • 0: Rx (received)
    • 1: Tx (transmit receipt)
    • 2: Tx Request (transmit request)
  • std::vector<uint8_t> Vector::BLF::MostPkt2::pktData {} β€” variable data Variable data
  • uint32_t Vector::BLF::MostPkt2::pktDataLength {} β€” length of variable data in bytes Length of variable data in bytes (1014 max) β€” note that max, bestie, 1014 is the ceiling, don't come for her πŸ“
  • uint8_t Vector::BLF::MostPkt2::priority {} β€” Priority
  • uint8_t Vector::BLF::MostPkt2::quadsToFollow {} β€” Number of quadlets
  • uint8_t Vector::BLF::MostPkt2::reservedMostPkt1 {} β€” reserved
  • uint8_t Vector::BLF::MostPkt2::reservedMostPkt2 {} β€” reserved
  • uint8_t Vector::BLF::MostPkt2::reservedMostPkt3 {} β€” reserved
  • uint16_t Vector::BLF::MostPkt2::reservedMostPkt4 {} β€” reserved
  • uint32_t Vector::BLF::MostPkt2::reservedMostPkt5 {} β€” reserved
  • uint32_t Vector::BLF::MostPkt2::sourceAdr {} β€” Source address
  • uint8_t Vector::BLF::MostPkt2::state {} β€” Transmission state
    • 0 for Rx
    • 0x40 for TxOk (transmit request)
  • uint8_t Vector::BLF::MostPkt2::timeRes {} β€” Obsolete member; read/write 0 β€” ok so she's obsolete, but you still gotta read/write 0, no cap, don't skip her πŸ™ˆ
  • uint8_t Vector::BLF::MostPkt2::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.
hiii just a lil note: five separate reserved members, all documented as "reserved". she's mysterious. she's not telling. respect her privacy πŸ’€

🌈 Author 🌈

Generated automatically by Doxygen for Vector BLF from the source code. (so don't come for the prose, a robot wrote the original, i just gave it a personality πŸŽ€)


k bye bestie, this page is from Vector BLF, page Vector::BLF::MostPkt2(3), and that's the whole manual name + version + everything β€” mwah πŸ’‹ go read some bytes πŸ¦‹β­

πŸ“¦ where this page comes from