Vector::BLF::LinMessage(3)

NAME 🎀

Vector::BLF::LinMessage — LIN_MESSAGE. This is the Library Functions Manual page for the Vector::BLF::LinMessage class, and yes, the main character energy is real. 💅

SYNOPSIS 💻

okay so first things first, the include is literally this:

#include <LinMessage.h>

Inherits Vector::BLF::ObjectHeader.

Public Member Functions 🫶

These are the functions this class brings to the group chat:

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

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

The inherited function lineup is:

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 💜

And from ObjectHeaderBase, we got:

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 ✨

Here's the public attribute squad, exactly as listed:

• uint16_t channel {} — application channel
• uint8_t id {} — LIN ID.
• uint8_t dlc {} — LIN DLC.
• std::array< uint8_t, 8 > data {}
• uint8_t fsmId {}
• uint8_t fsmState {}
• uint8_t headerTime {}
• uint8_t fullTime {}
• uint16_t crc {}
• uint8_t dir {} — direction
• uint8_t reservedLinMessage1 {}
• uint32_t reservedLinMessage2 {}

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

Inherited attribute cuties:

• 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 🧚

And the ObjectHeaderBase inherited attributes:

• 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 💅

The public enum is giving:

enum ObjectFlags : uint32_t { TimeTenMics = 0x00000001, TimeOneNans = 0x00000002 }

Detailed Description 😭

LIN_MESSAGE.

Deprecated 💀

LIN frame received or transmitted on a LIN channel.

Member Function Documentation 💖

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

Calculates the objectSize.

Returns — object size.

Reimplemented from Vector::BLF::ObjectHeaderBase.

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

Read the data of this object.

Parameters — is input stream.

Reimplemented from Vector::BLF::ObjectHeaderBase.

void Vector::BLF::LinMessage::write (AbstractFile & os) [override], [virtual] 📤

Write the data of this object.

Parameters — os output stream.

Reimplemented from Vector::BLF::ObjectHeaderBase.

Member Data Documentation 🍓

This is the data-member lore, bestie:

• uint16_t Vector::BLF::LinMessage::channel {} — application channel. Channel number where the frame sent/received.
• uint16_t Vector::BLF::LinMessage::crc {} — Checksum byte value.
• std::array<uint8_t, 8> Vector::BLF::LinMessage::data {} — Databyte values.
• uint8_t Vector::BLF::LinMessage::dir {} — direction. Direction of bus events:
  • 0: Rx (received)
  • 1: Tx (transmit receipt)
  • 2: Tx Request (transmit request)
• uint8_t Vector::BLF::LinMessage::dlc {} — LIN DLC. Frame length.
• uint8_t Vector::BLF::LinMessage::fsmId {} — Slave Identifier in the Final State Machine (obsolete)
• uint8_t Vector::BLF::LinMessage::fsmState {} — State Identifier of a Slave in the Final State Machine (obsolete)
• uint8_t Vector::BLF::LinMessage::fullTime {} — Duration of the entire frame [in bit times]
• uint8_t Vector::BLF::LinMessage::headerTime {} — Duration of the frame header [in bit times]
• uint8_t Vector::BLF::LinMessage::id {} — LIN ID. Frame identifier
• uint8_t Vector::BLF::LinMessage::reservedLinMessage1 {} — reserved
• uint32_t Vector::BLF::LinMessage::reservedLinMessage2 {} — reserved

Author 👑

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

---

That's the whole page, bestie 💖. Footer tea: source/version Vector BLF, manual page section 3, and the footer didn't print a date — so I'm not inventing one, periodt 💅✨.