VECTOR_BLF_CANOVERLOADFRAME(3)

Oh hey bestie 💖 welcome to the Vector::BLF::CanOverloadFrame(3) page from the Library Functions Manual — this is the class page for CAN_OVERLOAD, and it’s giving very “C++ library but make it group chat” energy. No cap, every detail is below.

🌸 NAME 🌸

Vector::BLF::CanOverloadFrame — CAN_OVERLOAD.

✨ SYNOPSIS ✨

#include <CanOverloadFrame.h>

Inherits Vector::BLF::ObjectHeader.

🫶 Public Member Functions 🫶

• void read (AbstractFile &is) override — read method for this object.
• void write (AbstractFile &os) override — write method for this object.
• uint32_t calculateObjectSize () const override — size-calculating method for this object.

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

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

• 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.
• uint16_t reservedCanOverloadFrame1 {} — reserved.
• uint32_t reservedCanOverloadFrame2 {} — reserved.

🌈 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 }

---

💖 Detailed Description 💖

CAN_OVERLOAD.

CAN overload frame received or transmitted on a CAN channel.

---

🔥 Member Function Documentation 🔥

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

[override], [virtual]

Calculates the objectSize.

• Returns: object size.
• Reimplemented from: Vector::BLF::ObjectHeaderBase.

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

Read the data of this object.

• Parameters: is — input stream.
• Reimplemented from: Vector::BLF::ObjectHeaderBase.

void Vector::BLF::CanOverloadFrame::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::CanOverloadFrame::channel {}

application channel — Channel the frame was sent or received.

uint16_t Vector::BLF::CanOverloadFrame::reservedCanOverloadFrame1 {}

reserved

uint32_t Vector::BLF::CanOverloadFrame::reservedCanOverloadFrame2 {}

reserved

---

👑 Author 👑

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

---

okay that’s the whole page, bestie 🫶 the footer’s source/version is Vector BLF, and there’s no date shown on the original footer — just the page tag Vector::BL...erloadFrame(3). mwah 💅