Vector::BL...ingChanged(3)

📦 version 2.4.2, in arch rolling

💅 Vector::BLF::CanSettingChanged — bestie's guide to the CAN setting glow-up ✨

okay so welcome to the manual page for Vector::BLF::CanSettingChanged(3) from the Vector BLF Library Functions Manual, and ngl this one is lowkey iconic: it's the little object that shows up when your CAN channel gets a reset or a bit timing change. main character energy fr fr 🎀

🌸 NAME 🌸

Vector::BLF::CanSettingChanged — the class itself, the moment, the vibe 💖

✨ SYNOPSIS ✨

#include <CanSettingChanged.h>

Inherits Vector::BLF::ObjectHeader — so like, it's part of the family, it's giving nepo baby but make it C++ 🫶

🦋 Public Member Functions

  • void read (AbstractFile &is) override — bestie reads stuff in
  • void write (AbstractFile &os) override — bestie writes stuff out
  • uint32_t calculateObjectSize () const override — bestie does the math on how big it is

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

  • ObjectHeader (const ObjectType objectType, const uint16_t objectVersion=0) — constructor moment
  • 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 — copy constructor, defaulted, no notes 💅
  • ObjectHeaderBase & operator= (const ObjectHeaderBase &)=default — copy assignment, also defaulted
  • ObjectHeaderBase (ObjectHeaderBase &&)=default — move constructor, defaulted
  • ObjectHeaderBase & operator= (ObjectHeaderBase &&)=default — move assignment, defaulted

🔥 Public Attributes 🔥

  • uint16_t channel — the application channel 🎯
  • uint8_t changedType — what kind of change happened: -1 - Invalid Type; 0 - Reseted; 1 - Bit Timing Changed
  • CanFdExtFrameData bitTimings — the actual bit timings, slay

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

  • uint32_t objectFlags {ObjectFlags::TimeOneNans} — object flags, iconic
  • 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 }

like, two flags, both slaying in their own way ✨

🌸 Detailed Description 🌸

Event that occurs when a reset or a bit timing change occurs on a CAN channel. no cap, that's literally the whole thing 💅

👑 Member Function Documentation 👑

🦋 uint32_t Vector::BLF::CanSettingChanged::calculateObjectSize () const

[override], [virtual]

Calculates the objectSize — it's doing the math so you don't have to 🧮

Returns object size

Reimplemented from Vector::BLF::ObjectHeaderBase.

🦋 void Vector::BLF::CanSettingChanged::read (AbstractFile & is)

[override], [virtual]

Read the data of this object 📥

Parameters is — input stream

Reimplemented from Vector::BLF::ObjectHeaderBase.

🦋 void Vector::BLF::CanSettingChanged::write (AbstractFile & os)

[override], [virtual]

Write the data of this object 📤

Parameters os — output stream

Reimplemented from Vector::BLF::ObjectHeaderBase.

🍓 Member Data Documentation 🍓

💜 uint8_t Vector::BLF::CanSettingChanged::changedType

-1 - Invalid Type; 0 - Reseted; 1 - Bit Timing Changed

The following values are possible:

  • -1: Invalid Change Type
  • 0: Reset event
  • 1: Bit timing changed

(iykyk — the -1 is the "no thoughts head empty" case 🙈)

💜 uint16_t Vector::BLF::CanSettingChanged::channel

application channel — Application channel. that's it, that's the whole description 💀

🌟 Author 🌟

Generated automatically by Doxygen for Vector BLF from the source code. not a human, just a robot doing its little thing 🤖💖

okay that's the page!! 🫶 this was Vector::BLF::CanSettingChanged(3) from the Vector BLF Library Functions Manual, footer edition — stay hydrated, go read your structs, and remember: bit timing changes are a lifestyle. periodt 💅✨🎀

📦 where this page comes from