Vector::BL...SpikeEvent(3)

okay bestie, this is the Vector::BL...SpikeEvent(3) page from the Library Functions Manual 💅 — yes, that’s the manual name, and we’re about to get into the LIN_SPIKE_EVENT of it all. No cap, every inherited member is coming too, because we don’t skip details in this group chat 🫶

✨ NAME ✨

Vector::BLF::LinSpikeEvent — LIN_SPIKE_EVENT. That’s the name section, short and iconic 🎀 periodt.

🦋 SYNOPSIS 🦋

Include it like this, bestie:

#include <LinSpikeEvent.h>

It inherits from Vector::BLF::ObjectHeader — the class is literally in its ObjectHeader era 👑

💅 Public Member Functions

• void read (AbstractFile &is) override — the public read override hook.
• void write (AbstractFile &os) override — the public write override hook.
• uint32_t calculateObjectSize () const override — calculates the object size, marked const and override.

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

• ObjectHeader (const ObjectType objectType, const uint16_t objectVersion=0) — inherited constructor with objectType and objectVersion=0.
• void read (AbstractFile &is) override — inherited read override.
• void write (AbstractFile &os) override — inherited write override.
• uint16_t calculateHeaderSize () const override — inherited header-size calculator.
• uint32_t calculateObjectSize () const override — inherited object-size calculator.

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

• ObjectHeaderBase (const uint16_t headerVersion, const ObjectType objectType) — inherited constructor with headerVersion and objectType.
• ObjectHeaderBase (const ObjectHeaderBase &)=default — copy constructor, defaulted.
• ObjectHeaderBase & operator= (const ObjectHeaderBase &)=default — copy assignment, defaulted.
• ObjectHeaderBase (ObjectHeaderBase &&)=default — move constructor, defaulted.
• ObjectHeaderBase & operator= (ObjectHeaderBase &&)=default — move assignment, defaulted.

🍓 Public Attributes

• uint16_t channel {} — application channel.
• uint16_t reservedLinSpikeEvent {} — reserved.
• uint32_t width {} — the spike’s width.

🌸 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

The way that this page has inherited members for days — here’s the enum, exactly this, no cap:

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

💀 Detailed Description 💀

LIN_SPIKE_EVENT.

Deprecated — the docs literally say Deprecated, so this is your cue to be careful, bestie. Not the main character energy you want to ignore 🫠

This event occurs when a short (normally less than 1 bit time) dominant signal has been detected on a LIN channel.

🧚 Member Function Documentation 🧚

💖 uint32_t Vector::BLF::LinSpikeEvent::calculateObjectSize () const

[override],  [virtual]

Calculates the objectSize

Returns: object size

Reimplemented from Vector::BLF::ObjectHeaderBase.

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

[override], [virtual]

Read the data of this object

Parameters: is is the input stream.

Reimplemented from Vector::BLF::ObjectHeaderBase.

🌟 void Vector::BLF::LinSpikeEvent::write (AbstractFile & os)

[override], [virtual]

Write the data of this object

Parameters: os is the output stream.

Reimplemented from Vector::BLF::ObjectHeaderBase.

🎀 Member Data Documentation 🎀

💖 uint16_t Vector::BLF::LinSpikeEvent::channel {}

application channel — Channel number where the frame sent/received.

🦋 uint16_t Vector::BLF::LinSpikeEvent::reservedLinSpikeEvent {}

reserved

🌸 uint32_t Vector::BLF::LinSpikeEvent::width {}

the spike’s width — Spike length in microseconds.

👑 Author 👑

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

---

okay that’s the page, bestie 🫶 — cute footer sign-off: source/version Vector BLF, page Vector::BL...SpikeEvent(3), and no date was printed on this footer, so I’m not inventing one. Stay iconic 💅