Vector::BL...ErrorFrame(3)

📦 version 2.4.2, in arch rolling

✨ Vector::BLF::CanErrorFrame(3) ✨

okay bestie, so like… this is from the Library Functions Manual and it's genuinely iconic for anyone working with Vector BLF files. The way this page is about CAN_ERROR and honestly it's giving "niche but essential" and I'm obsessed. 🎀

🌸 NAME 🌸

Vector::BLF::CanErrorFrame — literally just CAN_ERROR, no cap. That's it, that's the vibe. ✨

💜 SYNOPSIS 💜

okay so first things first, you gotta include the header like this:

#include <CanErrorFrame.h>

and lowkey this class inherits from Vector::BLF::ObjectHeader, which is literally giving family tree energy. 🫶

🌟 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::ObjectHeader

these are the ones you get for free, bestie, from the parent class:

  • 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 these come from the grandparent class, the whole ancestry is serving:

  • 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 {} — the application channel. iykyk 💅
  • uint16_t length {} — the CAN error frame length.
  • uint32_t reservedCanErrorFrame {} — reserved, so like, don't touch it bestie.

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

  • uint32_t objectFlags {ObjectFlags::TimeOneNans} — the object flags, cute.
  • uint16_t clientIndex {} — the client index of send node.
  • uint16_t objectVersion {0} — the object specific version.
  • uint64_t objectTimeStamp {} — the object timestamp, slay.

✨ Public Attributes inherited from Vector::BLF::ObjectHeaderBase

  • uint32_t signature {ObjectSignature} — the signature (literally ObjectSignature, iconic).
  • uint16_t headerSize {} — sizeof object header.
  • uint16_t headerVersion {} — the header version and it's 1 bestie.
  • uint32_t objectSize {} — the object size.
  • ObjectType objectType {ObjectType::UNKNOWN} — the object type.

🧚 Additional Inherited Members 🧚

🔥 Public Types inherited from Vector::BLF::ObjectHeader

this enum is giving options, periodt:

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

🦋 Detailed Description 🦋

CAN_ERROR — that's the whole vibe.

it's a CAN error frame received or transmitted on a CAN channel, no cap. like, the frame was out there living its main character life on the bus and now it's here. 💖

🎀 Member Function Documentation 🎀

⭐ uint32_t Vector::BLF::CanErrorFrame::calculateObjectSize () const

[override], [virtual] — okay so this one calculates the objectSize, slay.

Returns : the object size (obviously bestie).

Reimplemented from Vector::BLF::ObjectHeaderBase.

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

Read the data of this object — literally what it says on the tin.

Parameters : is — input stream, the data comes from here.

Reimplemented from Vector::BLF::ObjectHeaderBase.

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

Write the data of this object — and this one sends it out, iconic.

Parameters : os — output stream, the data goes here.

Reimplemented from Vector::BLF::ObjectHeaderBase.

🌈 Member Data Documentation 🌈

✨ uint16_t Vector::BLF::CanErrorFrame::channel {}

the application channel. Channel the frame was sent or received. iykyk which channel it was on. 💅

🍓 uint16_t Vector::BLF::CanErrorFrame::length {}

the CAN error frame length. Length of error frame - can be left 0. so like, zero is valid bestie, don't stress. 😭

💜 uint32_t Vector::BLF::CanErrorFrame::reservedCanErrorFrame {}

reserved — that's it, that's the whole description. hands off. 🙈

👑 Author 👑

Generated automatically by Doxygen for Vector BLF from the source code. so like, no human wrote this, the machine did, and honestly? it ate. 🤖✨

okay bestie that's the whole page — literally every single detail preserved, every member, every {} default, every override tag, all of it. this page is from Vector BLF and it's so the kind of documentation you keep in your group chat for when someone's like "what even is a CAN error frame". kisses, hope this helped, mwah! 🎀💖✨ Vector BLF, periodt. 🦋

📦 where this page comes from