VECTOR_BLF_CANDRIVERERROR(3)

okay so bestie, welcome to Vector::BL...DriverError(3) from the Library Functions Manual — this is the class page for Vector::BLF::CanDriverError, and the whole vibe is literally CAN_DRIVER_ERROR 💅

🌸 NAME 🌸

Vector::BLF::CanDriverError — CAN_DRIVER_ERROR.

No cap, that's the name. 🫶

✨ SYNOPSIS ✨

#include <CanDriverError.h>

Inherits Vector::BLF::ObjectHeader — yes bestie, it's in the family tree 🌳

💅 Public Member Functions

• void read (AbstractFile &is) override — reads this object's data from is. Input stream energy ✨
• void write (AbstractFile &os) override — writes this object's data to os. Output stream slay 💖
• uint32_t calculateObjectSize () const override — calculates the object size and returns it. Math but make it cute 🎀

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

• ObjectHeader (const ObjectType objectType, const uint16_t objectVersion=0) — builds an ObjectHeader from objectType and objectVersion, and objectVersion defaults to 0 ⭐
• void read (AbstractFile &is) override — inherited read, reads from is 🦋
• void write (AbstractFile &os) override — inherited write, writes to os 🌸
• uint16_t calculateHeaderSize () const override — inherited header-size calculator, doing its little header-size thing 💫
• uint32_t calculateObjectSize () const override — inherited object-size calculator, returns object size 🔥

🎀 Public Member Functions inherited from Vector::BLF::ObjectHeaderBase

• ObjectHeaderBase (const uint16_t headerVersion, const ObjectType objectType) — builds an ObjectHeaderBase from headerVersion and objectType 🧚
• ObjectHeaderBase (const ObjectHeaderBase &)=default — defaulted copy constructor, iconic copy behavior 👑
• ObjectHeaderBase & operator= (const ObjectHeaderBase &)=default — defaulted copy assignment, assignment but make it default 💜
• ObjectHeaderBase (ObjectHeaderBase &&)=default — defaulted move constructor, move-out energy 🌈
• ObjectHeaderBase & operator= (ObjectHeaderBase &&)=default — defaulted move assignment, move-assign era 💫

🍓 Public Attributes

• uint16_t channel {} — application channel
• uint8_t txErrors {} — # of TX errors
• uint8_t rxErrors {} — # of RX errors
• uint32_t errorCode {} — CAN driver error code.

🌸 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 } — the ObjectFlags enum, with TimeTenMics = 0x00000001 and TimeOneNans = 0x00000002 ⭐

💖 Detailed Description 💖

CAN_DRIVER_ERROR.

CAN driver error information for transceiver of a CAN channel.

✨ Member Function Documentation ✨

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

[override], [virtual]

Calculates the objectSize

Returns — object size

Reimplemented from Vector::BLF::ObjectHeaderBase.

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

Read the data of this object

Parameters — is input stream

Reimplemented from Vector::BLF::ObjectHeaderBase.

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

Write the data of this object

Parameters — os output stream

Reimplemented from Vector::BLF::ObjectHeaderBase.

🎀 Member Data Documentation 🎀

uint16_t Vector::BLF::CanDriverError::channel {}

application channel CAN channel the driver error information belongs to.

uint32_t Vector::BLF::CanDriverError::errorCode {}

CAN driver error code. Error code

uint8_t Vector::BLF::CanDriverError::rxErrors {}

# of RX errors Number of receive errors that occurred in CAN controller for that channel.

uint8_t Vector::BLF::CanDriverError::txErrors {}

# of TX errors Number of transmit errors that occurred in CAN controller for that channel.

🌈 Author 🌈

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

---

sign-off from the footer, bestie: Vector BLF · Vector::BL...DriverError(3) — no date printed on this one, that's literally the footer vibe 💜🎀