VECTOR_BLF_LINSPIKEEVENT2(3)

📦 version 2.4.2, in arch rolling

💖 Vector::BLF::LinSpikeEvent2 — LIN_SPIKE_EVENT2 💖

okay bestie, quick vibe check: this page lives in the Library Functions Manual, and the man page id is Vector::BL...SpikeEvent2(3). The actual main character is Vector::BLF::LinSpikeEvent2, and we're about to go through every single deet. no skips, no cap. ✨

✨ NAME ✨

Vector::BLF::LinSpikeEvent2 — LIN_SPIKE_EVENT2. that's the whole name section, short and iconic. 💅

🌸 SYNOPSIS 🌸

#include <LinSpikeEvent2.h>

Inherits Vector::BLF::ObjectHeader, and Vector::BLF::LinBusEvent.

🫶 Public Member Functions

💅 its own public member functions

  • void read (AbstractFile &is) override — reads from an AbstractFile and it's an override, bestie.
  • void write (AbstractFile &os) override — writes to an AbstractFile, also an override.
  • uint32_t calculateObjectSize () const override — calculates the object size and returns a uint32_t, override energy.

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

  • ObjectHeader (const ObjectType objectType, const uint16_t objectVersion=0) — constructor for ObjectHeader, with objectType and an optional objectVersion defaulting to 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, returns uint16_t.
  • uint32_t calculateObjectSize () const override — inherited object-size calculator, returns uint32_t.

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

  • ObjectHeaderBase (const uint16_t headerVersion, const ObjectType objectType) — constructor taking 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 Member Functions inherited from Vector::BLF::LinBusEvent

  • LinBusEvent (const LinBusEvent &)=default — copy constructor, defaulted.
  • LinBusEvent & operator= (const LinBusEvent &)=default — copy assignment, defaulted.
  • LinBusEvent (LinBusEvent &&)=default — move constructor, defaulted.
  • LinBusEvent & operator= (LinBusEvent &&)=default — move assignment, defaulted.

🎀 Public Attributes

⭐ its own public attributes

  • uint32_t width {} — the spike's width in microseconds. also described as spike length in microseconds. both deets live here, bestie.
  • uint8_t internal {} — flag saying whether this event is simulated or real; the full tea is in the member data section below.
  • uint8_t reservedLinSpikeEvent1 {} — reserved.
  • uint16_t reservedLinSpikeEvent2 {} — 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.

💜 Public Attributes inherited from Vector::BLF::LinBusEvent

  • uint64_t sof {} — Start Of Frame timestamp.
  • uint32_t eventBaudrate {} — Baudrate of the event in bit/sec.
  • uint16_t channel {} — application channel.
  • uint16_t reservedLinBusEvent {} — just listed here with no extra description in the source, bestie.

🌟 Additional Inherited Members 🌟

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

the enum is giving very specific little values, and we're keeping them exactly:

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

🔥 Detailed Description 🔥

so LIN_SPIKE_EVENT2 is the event that happens when a short dominant signal has been detected on a LIN channel. and when we say short, we mean normally less than 1 bit time. that's the moment, that's the vibe. 🦋

😭 Member Function Documentation 😭

🧮 uint32_t Vector::BLF::LinSpikeEvent2::calculateObjectSize () const

[override], [virtual]

Calculates the objectSize.

Returns: object size.

Reimplemented from Vector::BLF::ObjectHeaderBase.

📖 void Vector::BLF::LinSpikeEvent2::read (AbstractFile & is)

[override], [virtual]

Read the data of this object.

Parameters: is input stream.

Reimplemented from Vector::BLF::ObjectHeaderBase.

✍️ void Vector::BLF::LinSpikeEvent2::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::LinSpikeEvent2::internal {}

Flag indicating whether this event is a simulated one:

  • 0: real event
  • 1: simulated event

🧸 uint8_t Vector::BLF::LinSpikeEvent2::reservedLinSpikeEvent1 {}

reserved.

🎀 uint16_t Vector::BLF::LinSpikeEvent2::reservedLinSpikeEvent2 {}

reserved.

📏 uint32_t Vector::BLF::LinSpikeEvent2::width {}

the spike's width in microseconds. also: Spike length in microseconds. same energy, both facts kept. 💖

🎀 Author 🎀

Generated automatically by Doxygen for Vector BLF from the source code. yes, the robots generated it, and I gave it the group-chat treatment. 💅

💌 sign-off: source/version is Vector BLF, page id is Vector::BL...SpikeEvent2(3). date: not printed on this page, bestie. 🫶✨

📦 where this page comes from