VECTOR_BLF_LINSCHEDULERMODECHANGE(3)

📦 version 2.4.2, in arch rolling

💅 Vector::BLF::LinSchedulerModeChange(3) — Library Functions Manual, but make it cute

okay so bestie, we're in the Library Functions Manual today and the star of the show is literally Vector::BLF::LinSchedulerModeChange. yes that's a mouthful, no i will not be shortening it, it's giving ✨academic✨.

🌸 NAME 🌸

Vector::BLF::LinSchedulerModeChange — aka LIN_SCHED_MODCH. that's it. that's the name. slay 💅

✨ SYNOPSIS ✨

first things first, you gotta let the compiler know she exists:

#include <LinSchedulerModeChange.h>

and she inherits from Vector::BLF::ObjectHeader — so like, she's got a whole family tree, we'll get to that 🫶

🎀 Public Member Functions 🎀

these are the ones she owns herself:

  • void read (AbstractFile &is) override — reads her data in, override energy only
  • void write (AbstractFile &os) override — writes her data out, also override, also iconic
  • uint32_t calculateObjectSize () const override — does the math on her size, const because she's not about to change mid-calculation

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

the family inheritance, no cap:

  • ObjectHeader (const ObjectType objectType, const uint16_t objectVersion=0) — constructor, note the default objectVersion is 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

the grandparent generation, and yes she's got the full copy/move situation:

  • ObjectHeaderBase (const uint16_t headerVersion, const ObjectType 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 🍓

her own personal fields, all initialized to {} because she's tidy:

  • uint16_t channel {} — the application channel
  • uint8_t oldMode {}
  • uint8_t newMode {}
  • uint32_t reservedLinSchedulerModeChange {}

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

  • uint32_t objectFlags {ObjectFlags::TimeOneNans} — the object flags, defaults to TimeOneNans
  • uint16_t clientIndex {} — client index of the send node
  • uint16_t objectVersion {0} — object specific version, starts at 0
  • uint64_t objectTimeStamp {} — the object's timestamp

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

  • uint32_t signature {ObjectSignature} — the signature, default ObjectSignature
  • uint16_t headerSize {} — sizeof object header
  • uint16_t headerVersion {} — header version, and that's a 1 bestie
  • uint32_t objectSize {} — object size
  • ObjectType objectType {ObjectType::UNKNOWN} — object type, defaults to ObjectType::UNKNOWN

🧚 Additional Inherited Members 🧚

Public Types inherited from Vector::BLF::ObjectHeader

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

two flags, TimeTenMics at 0x00000001 and TimeOneNans at 0x00000002. memorize them, there will be a quiz (there will not be a quiz) 😭

👑 Detailed Description 👑

LIN_SCHED_MODCH. periodt.

so like, when does this info event even happen? listen closely bestie:

This info event occurs when a Master is simulated and a frame header of a new schedule table is transmitted for the first time. This info event may appear on starting a measurement.

so: simulated Master + first-ever frame header of a new schedule table = this event shows up. and it may appear when you start a measurement. main character energy honestly 🦋

🔥 Member Function Documentation 🔥

🌟 uint32_t Vector::BLF::LinSchedulerModeChange::calculateObjectSize () const

[override], [virtual] — she's doing both, she's an overachiever.

Calculates the objectSize.

Returns: object size. that's the whole return. object size. thank you for coming to my ted talk ✨

Reimplemented from Vector::BLF::ObjectHeaderBase.

🌟 void Vector::BLF::LinSchedulerModeChange::read (AbstractFile & is)

[override], [virtual]

Read the data of this object.

Parameters:

  • is — input stream (catch that pun, an input stream literally named is, obsessed 💀)

Reimplemented from Vector::BLF::ObjectHeaderBase.

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

[override], [virtual]

Write the data of this object.

Parameters:

  • os — output stream (and yes the output stream is os, the naming is chef's kiss)

Reimplemented from Vector::BLF::ObjectHeaderBase.

💖 Member Data Documentation 💖

uint16_t Vector::BLF::LinSchedulerModeChange::channel {}

application channel. more specifically: channel number where the frame sent/received. 🎀

uint8_t Vector::BLF::LinSchedulerModeChange::newMode {}

Index (0-based) of the newly activated schedule table. zero-based, so the first one is 0, don't embarrass yourself 🫶

uint8_t Vector::BLF::LinSchedulerModeChange::oldMode {}

Index (0-based) of a previously active schedule table. previously. past tense. she's moved on 💅

uint32_t Vector::BLF::LinSchedulerModeChange::reservedLinSchedulerModeChange {}

reserved. that's it. that's the whole description. don't touch her, she's reserved 🙈

🌸 Author 🌸

Generated automatically by Doxygen for Vector BLF from the source code. not me writing this by hand when Doxygen just... does that. anyway 💀

that's the whole page bestie, go forth and schedule your LIN modes responsibly 🦋✨💖

with love, the Vector BLF manual (Library Functions Manual), Vector::BL...rModeChange(3) — mwah 🎀

📦 where this page comes from