Vector::BL...ktFragment(3)

💖 Vector::BLF::MostEthernetPktFragment 💖

okay so this is the Vector::BL...ktFragment(3) page from the Library Functions Manual (the Vector BLF one), and the whole assignment is: it’s the MOST_ETHERNET_PKT_FRAGMENT class. Header truncated the title like that, we’re folding the manual name in right here, bestie. 🫶

🌸 NAME 🌸

Vector::BLF::MostEthernetPktFragment — MOST_ETHERNET_PKT_FRAGMENT. That’s the name, that’s the vibe, periodt. 💅

✨ SYNOPSIS ✨

#include <MostEthernetPktFragment.h>

Inherits Vector::BLF::ObjectHeader2. No cap.

💅 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

🌈 Public Attributes 🌈

• uint16_t channel {} — application channel. Application channel, double-confirmed. ✨
• uint8_t reservedMostEthernetPktFragment1 {} — reserved.
• uint8_t ackNack {} — acknowledge code.
• uint32_t validMask {} — bitfield indicating which members have valid data.
• uint64_t sourceMacAdr {} — 48 bit source address.
• uint64_t destMacAdr {} — 48 bit target address.
• uint8_t pAck {} — a preemptive acknowledge code.
• uint8_t cAck {} — CRC acknowledge from the packet receiver(s) to the packet transmitter.
• uint16_t reservedMostEthernetPktFragment2 {} — reserved.
• uint32_t crc {} — Cyclic Redundancy Check.
• uint32_t dataLen {} — number of transmitted user data bytes.
• uint32_t dataLenAnnounced {} — announced user data length at the start of the transmission.
• uint32_t firstDataLen {} — number of bytes in firstData.
• uint32_t reservedMostEthernetPktFragment3 {} — reserved.
• std::vector< uint8_t > firstData {} — 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 }

🦋 Detailed Description 🦋

MOST_ETHERNET_PKT_FRAGMENT.

Partial transmitted message on MOST Ethernet Packet Channel. It’s giving “fragment of a transmitted message on the MOST Ethernet Packet Channel” realness, lowkey iconic. ✨

💅 Member Function Documentation 💅

uint32_t Vector::BLF::MostEthernetPktFragment::calculateObjectSize () const

[override], [virtual]. Calculates the objectSize.

Returns: object size.

Reimplemented from Vector::BLF::ObjectHeaderBase.

void Vector::BLF::MostEthernetPktFragment::read (AbstractFile & is)

[override], [virtual]. Read the data of this object.

Parameters: is input stream.

Reimplemented from Vector::BLF::ObjectHeaderBase.

void Vector::BLF::MostEthernetPktFragment::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::MostEthernetPktFragment::ackNack {}

acknowledge code. AckNack holds the transmit status of a control message (see Transmit Status Register of OS8104 for MOST25).

• Bit 0 — Meaning: 1: no response (NoResp). Restriction: only for Dir = Tx or spy messages.
• Bit 1 — Meaning: 1: valid receipt (Valid). Restriction: only for Dir = Tx or spy messages.
• Bit 2 — Meaning: 1: CRC Error (CRCError). Restriction: only for Dir = Tx or spy messages.
• Bit 3 — Meaning: 1: receive buffer full (RxBufFull). Restriction: only for Dir = Tx or spy messages.
• Bit 4 — Meaning: 1: acknowledged (Ack). Restriction: only for Dir = Tx or spy messages (always set to 1 for Rx messages in node mode).
• Bit 5 — Meaning: 1: negative acknowledge (NAck). Restriction: only for Dir = Tx or spy messages.

uint8_t Vector::BLF::MostEthernetPktFragment::cAck {}

CRC acknowledge from the packet receiver(s) to the packet transmitter. The original says it twice, so yes: CRC acknowledge from the packet receiver(s) to the packet transmitter. 🫶

• 0x00: No Response
• 0x01: CRC error
• 0x04: OK

uint16_t Vector::BLF::MostEthernetPktFragment::channel {}

application channel. Application channel.

uint32_t Vector::BLF::MostEthernetPktFragment::crc {}

Cyclic Redundancy Check. Cyclic Redundancy Check. (They said it twice; we’re respecting the repetition.)

uint32_t Vector::BLF::MostEthernetPktFragment::dataLen {}

number of transmitted user data bytes. Number of transmitted user data bytes. These bytes were counted on bus.

Note: The number of bytes saved in this event is stored in firstDataLen.

uint32_t Vector::BLF::MostEthernetPktFragment::dataLenAnnounced {}

announced user data length at the start of the transmission. Announced user data length at start of transmission.

In some cases (e.g. sending to an invalid target address, receive buffer full of target device) the transmission is terminated before all data bytes have been sent. Then the counted number of bytes on bus is less than the announced data length (dataLen < dataLenAnnonced). Due to rare and very specific bit errors (degrade of end termination byte) dataLen can also be greater than dataLenAnnonced.

uint64_t Vector::BLF::MostEthernetPktFragment::destMacAdr {}

48 bit target address. 48 bit target address.

std::vector<uint8_t> Vector::BLF::MostEthernetPktFragment::firstData {}

variable data. Variable data.

uint32_t Vector::BLF::MostEthernetPktFragment::firstDataLen {}

number of bytes in firstData. Number of bytes stored in firstData (1524 max).

Note: In order to limit the size of this event not all counted bytes on bus will be stored in the payload of the logging event.

uint8_t Vector::BLF::MostEthernetPktFragment::pAck {}

a preemptive acknowledge code. Pre-emptive acknowledge code.

• 0x00: No Response
• 0x01: Buffer full
• 0x04: OK

uint8_t Vector::BLF::MostEthernetPktFragment::reservedMostEthernetPktFragment1 {}

reserved.

uint16_t Vector::BLF::MostEthernetPktFragment::reservedMostEthernetPktFragment2 {}

reserved.

uint32_t Vector::BLF::MostEthernetPktFragment::reservedMostEthernetPktFragment3 {}

reserved.

uint64_t Vector::BLF::MostEthernetPktFragment::sourceMacAdr {}

48 bit source address. 48 bit source address.

uint32_t Vector::BLF::MostEthernetPktFragment::validMask {}

bitfield indicating which members have valid data. If a bit in the mask is set, the corresponding data field has been seen on the bus.

• Bit 0: 0x00000001: dataLenAnnounced
• Bit 1: 0x00000002: sourceAdr
• Bit 2: 0x00000004: destAdr
• Bit 3: 0x00000008: ackNack
• Bit 4: 0x00000010: pAck
• Bit 5: 0x00000020: pIndex
• Bit 6: 0x00000040: piority
• Bit 7: 0x00000080: crc
• Bit 8: 0x00000100: cAck
• Bit 9: 0x00000200: sourceMacAdr
• Bit 10: 0x00000400: destMacAdr
• Bit 31: 0x80000000: 0: MOST150 fragment; 1: MOST50 fragment

👑 Author 👑

Generated automatically by Doxygen for Vector BLF from the source code. Robots wrote it, and honestly? They ate. 💅✨

---

Source/version: Vector BLF. Date: the original footer doesn’t show a separate visible date — it just repeats the Vector::BL...ktFragment(3) manual-title vibe — so that’s the footer tea, bestie. 🫶💖