VECTOR_BLF_MOST150MESSAGEFRAGMENT(3)

πŸ“¦ version 2.4.2, in arch rolling

✨ NAME ✨

okay bestie, welcome to the Vector::BLF::Most150MessageFragment page from the Library Functions Manual πŸ’–. The name is literally Vector::BLF::Most150MessageFragment β€” MOST_150_MESSAGE_FRAGMENT. no cap.

✨ SYNOPSIS ✨

Here is the whole synopsis, copied exactly so nobody comes for me πŸ’…:

       #include <Most150MessageFragment.h>

       Inherits Vector::BLF::ObjectHeader2.

   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
       uint8_t reservedMost150MessageFragment1 {}
       uint8_t ackNack {}
           acknowledge code
       uint32_t validMask {}
           bitfield indicating which members have valid data
       uint32_t sourceAdr {}
           source address
       uint32_t destAdr {}
           target address
       uint8_t pAck {}
           a preemptive acknowledge code
       uint8_t cAck {}
           CRC acknowledge from the packet receiver(s) to the packet
           transmitter.
       uint8_t priority {}
           priority of the message
       uint8_t pIndex {}
           packet index, increments per message on MOST
       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 reservedMost150MessageFragment2 {}
       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_150_MESSAGE_FRAGMENT.

Partial transmitted MOST50 or MOST150 Control Channel message. Fragments are reported from a network spy if the message transmission is corrupted or terminated.

πŸ’… MEMBER FUNCTION DOCUMENTATION πŸ’…

These are the member functions, bestie β€” with all the override/virtual energy kept intact.

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

  • [override], [virtual]
  • Calculates the objectSize.
  • Returns: object size
  • Reimplemented from Vector::BLF::ObjectHeaderBase.

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

  • [override], [virtual]
  • Read the data of this object.
  • Parameters: is input stream
  • Reimplemented from Vector::BLF::ObjectHeaderBase.

void Vector::BLF::Most150MessageFragment::write (AbstractFile & os)

  • [override], [virtual]
  • Write the data of this object.
  • Parameters: os output stream
  • Reimplemented from Vector::BLF::ObjectHeaderBase.

πŸ“ MEMBER DATA DOCUMENTATION πŸ“

Okay now the data members, one by one, no skipping πŸ’….

uint8_t Vector::BLF::Most150MessageFragment::ackNack {}

This is the 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::Most150MessageFragment::cAck {}

CRC acknowledge from the packet receiver(s) to the packet transmitter. CRC acknowledge from the packet receiver(s) to the packet transmitter. (Yes, it repeats β€” iconic.)

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

uint16_t Vector::BLF::Most150MessageFragment::channel {}

application channel β€” Application channel. πŸ’–

uint32_t Vector::BLF::Most150MessageFragment::crc {}

Cyclic Redundancy Check. Cyclic Redundancy Check.

uint32_t Vector::BLF::Most150MessageFragment::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::Most150MessageFragment::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.

uint32_t Vector::BLF::Most150MessageFragment::destAdr {}

target address β€” Target address.

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

variable data β€” Variable data.

uint32_t Vector::BLF::Most150MessageFragment::firstDataLen {}

number of bytes in firstData β€” Number of bytes stored in mFirstData (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::Most150MessageFragment::pAck {}

a preemptive acknowledge code β€” Pre-emptive acknowledge code.

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

uint8_t Vector::BLF::Most150MessageFragment::pIndex {}

packet index, increments per message on MOST β€” Packet index, increments per message on MOST.

uint8_t Vector::BLF::Most150MessageFragment::priority {}

priority of the message β€” Priority.

uint8_t Vector::BLF::Most150MessageFragment::reservedMost150MessageFragment1 {}

reserved.

uint32_t Vector::BLF::Most150MessageFragment::reservedMost150MessageFragment2 {}

reserved.

uint32_t Vector::BLF::Most150MessageFragment::sourceAdr {}

source address β€” Source address.

uint32_t Vector::BLF::Most150MessageFragment::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 β€” yes, that's the exact spelling in the original, bestie πŸ™ˆ
  • 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. slay, Doxygen.


okay that's the whole page, bestie πŸ’– β€” big ups to Vector BLF for the source/version, and the footer didn't show a date so I'm not inventing one 🫢. Vector::BL...ageFragment(3) signing off. πŸ’…

πŸ“¦ where this page comes from