Vector::BL...iverHwSync(3)

📦 version 2.4.2, in arch rolling

✨ NAME ✨

Vector::BLF::CanDriverHwSync — CAN_DRIVER_SYNC. That's the whole vibe, bestie. 💅

✨ SYNOPSIS ✨

Okay so first things first, you're gonna include this header, no cap:

#include <CanDriverHwSync.h>

And it inherits from Vector::BLF::ObjectHeader — like, that's its whole ancestry, periodt. 🧬

🌟 Public Types 🌟

The enum Flags is giving uint8_t energy, and it's literally this:

enum Flags : uint8_t { Tx = 1, Rx = 2, RxThis = 4 }

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

Not me showing you the inherited enum too, because bestie, it's important:

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

🦋 Public Member Functions 🦋

Here's the main character energy — three functions that do the absolute most:

  • void read (AbstractFile &is) override — reads the data of this object, iykyk. ✨
  • void write (AbstractFile &os) override — writes the data of this object, slay. 💖
  • uint32_t calculateObjectSize () const override — calculates the objectSize, no biggie. 🔥

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

These are the ones it got from its parent, and they're iconic:

  • ObjectHeader (const ObjectType objectType, const uint16_t objectVersion=0) — the constructor, living its best life.
  • void read (AbstractFile &is) override — inherited read, still eating.
  • void write (AbstractFile &os) override — inherited write, still slaying.
  • uint16_t calculateHeaderSize () const override — calculates the header size, periodt.
  • uint32_t calculateObjectSize () const override — calculates the object size, again, but inherited this time. 💅

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

And these are from the grandparent, lowkey essential:

  • ObjectHeaderBase (const uint16_t headerVersion, const ObjectType objectType) — constructor, doing its thing.
  • ObjectHeaderBase (const ObjectHeaderBase &)=default — copy constructor, default, no cap.
  • ObjectHeaderBase & operator= (const ObjectHeaderBase &)=default — copy assignment, default, fr fr.
  • ObjectHeaderBase (ObjectHeaderBase &&)=default — move constructor, default, bestie.
  • ObjectHeaderBase & operator= (ObjectHeaderBase &&)=default — move assignment, default, and that's on periodt. 🫶

🍓 Public Attributes 🍓

Okay so the attributes are giving data, and they're all here:

  • uint16_t channel {} — channel where sync occured Application channel. (Yes, that's exactly what it says, don't @ me.) 📡
  • uint8_t flags {} — flags. That's it. That's the description. 💀
  • uint8_t reservedCanDriverHwSync1 {} — reserved. Hands off, bestie. 🙈
  • uint32_t reservedCanDriverHwSync2 {} — reserved. Also hands off. 🫣

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

These came from the parent and they're still valid:

  • uint32_t objectFlags {ObjectFlags::TimeOneNans} — object flags, cute.
  • uint16_t clientIndex {} — client index of send node, iconic.
  • uint16_t objectVersion {0} — object specific version, zero by default.
  • uint64_t objectTimeStamp {} — object timestamp, literally time. ⏰

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

And the grandparent's attributes, because we keep it thorough:

  • uint32_t signature {ObjectSignature} — signature (ObjectSignature), main character energy.
  • uint16_t headerSize {} — sizeof object header, no cap.
  • uint16_t headerVersion {} — header version (1), periodt.
  • uint32_t objectSize {} — object size, you know it.
  • ObjectType objectType {ObjectType::UNKNOWN} — object type, defaulting to UNKNOWN, which is a whole mood. 👑

✨ Detailed Description ✨

CAN_DRIVER_SYNC.

Event that occurs when hardware sync is executed. That's the tea, bestie. It's giving "hardware sync just happened" and we're obsessed. 🎀

🎀 Member Enumeration Documentation 🎀

🧚 enum Vector::BLF::CanDriverHwSync::Flags : uint8_t 🧚

This is the enumeration for flags — like, the literal flags, iykyk. Here's the breakdown:

  • Tx — sync was sent from this channel. Slay. 📤
  • Rx — external sync received. Iconic. 📥
  • RxThis — sync received but generated from this hardware. So it's a little bit of both, fr fr. 🔄

🧚 Member Function Documentation 🧚

🧚 uint32_t Vector::BLF::CanDriverHwSync::calculateObjectSize () const 🧚

[override], [virtual]

Calculates the objectSize. That's literally what it does.

Returns: object size.

Reimplemented from Vector::BLF::ObjectHeaderBase.

🧚 void Vector::BLF::CanDriverHwSync::read (AbstractFile & is) 🧚

[override], [virtual]

Read the data of this object. You know the drill.

Parameters: is input stream.

Reimplemented from Vector::BLF::ObjectHeaderBase.

🧚 void Vector::BLF::CanDriverHwSync::write (AbstractFile & os) 🧚

[override], [virtual]

Write the data of this object. Go off, bestie.

Parameters: os output stream.

Reimplemented from Vector::BLF::ObjectHeaderBase.

💜 Member Data Documentation 💜

💜 uint16_t Vector::BLF::CanDriverHwSync::channel {} 💜

channel where sync occured Application channel. (Yes, exactly as written. The spelling is "occured" and we're keeping it. 💖)

💜 uint8_t Vector::BLF::CanDriverHwSync::flags {} 💜

flags. That's the whole description. It's giving minimalism. ✨

💜 uint8_t Vector::BLF::CanDriverHwSync::reservedCanDriverHwSync1 {} 💜

reserved — like, don't touch, it's reserved for a reason, bestie 💀

💜 uint32_t Vector::BLF::CanDriverHwSync::reservedCanDriverHwSync2 {} 💜

reserved — again, hands off, it's giving "not for you" 🫣

🌈 Author 🌈

Generated automatically by Doxygen for Vector BLF from the source code. So it's literally the source's child, no cap. 🧚

Alright bestie, that's the whole manual page. Served to you by Vector BLF 💖 and the date (you know the one, it's in the footer, iykyk) 🎀. Stay synced! 💅✨

📦 where this page comes from