Vector::BL...isticEvent(3)

πŸ“¦ version 2.4.2, in arch rolling

πŸ’– NAME πŸ’–

okay so bestie, you're on the Vector::BL...isticEvent(3) page from the Library Functions Manual for Vector BLF πŸ“šβœ¨ and this whole page is about Vector::BLF::LinStatisticEvent β€” aka LIN_STATISTIC. That's the name, that's the vibe, periodt πŸ’….


🌸 SYNOPSIS 🌸

First things first, the include:

#include <LinStatisticEvent.h>

It inherits from Vector::BLF::ObjectHeader. Iconic inheritance behavior, no cap 🧬✨.

✨ Public Member Functions ✨

void read (AbstractFile &is) override
void write (AbstractFile &os) override
uint32_t calculateObjectSize () const override

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

ObjectHeader (const ObjectType objectType, const uint16_t
    objectVersion=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 ✨

ObjectHeaderBase (const uint16_t headerVersion, const ObjectType
    objectType)
ObjectHeaderBase (const ObjectHeaderBase &)=default
ObjectHeaderBase & operator= (const ObjectHeaderBase &)=default
ObjectHeaderBase (ObjectHeaderBase &&)=default
ObjectHeaderBase & operator= (ObjectHeaderBase &&)=default

✨ Public Attributes ✨

The data squad, exactly as declared:

uint16_t channel {}
uint16_t reservedLinStatisticEvent1 {}
uint32_t reservedLinStatisticEvent2 {}
double busLoad {}
uint32_t burstsTotal {}
uint32_t burstsOverrun {}
uint32_t framesSent {}
uint32_t framesReceived {}
uint32_t framesUnanswered {}
uint32_t reservedLinStatisticEvent3 {}
  • uint16_t channel {} β€” application channel πŸ’Œ
  • uint16_t reservedLinStatisticEvent1 {} β€” reserved, not for us πŸ™ˆ
  • uint32_t reservedLinStatisticEvent2 {} β€” reserved, again πŸ’€
  • double busLoad {} β€” bus load 🚌
  • uint32_t burstsTotal {} β€” bursts total ⚑
  • uint32_t burstsOverrun {} β€” bursts overrun πŸƒβ€β™€οΈ
  • uint32_t framesSent {} β€” frames sent βœ‰οΈ
  • uint32_t framesReceived {} β€” frames received πŸ“¬
  • uint32_t framesUnanswered {} β€” frames unanswered 😭
  • uint32_t reservedLinStatisticEvent3 {} β€” reserved, the third one πŸ‘‘
  • uint16_t reservedLinStatisticEvent1 {} β€” reserved 🫢
  • uint32_t reservedLinStatisticEvent2 {} β€” reserved 🌸
  • uint32_t reservedLinStatisticEvent3 {} β€” reserved πŸŽ€

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

uint32_t objectFlags {ObjectFlags::TimeOneNans}
uint16_t clientIndex {}
uint16_t objectVersion {0}
uint64_t objectTimeStamp {}
  • 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}
uint16_t headerSize {}
uint16_t headerVersion {}
uint32_t objectSize {}
ObjectType objectType {ObjectType::UNKNOWN}
  • 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 }

That's the enum tea: TimeTenMics = 0x00000001 and TimeOneNans = 0x00000002 β˜•βœ¨.


πŸ’… Detailed Description πŸ’…

okay so the detailed description is literally just LIN_STATISTIC. β€” short and mysterious, main character energy πŸ•ΆοΈ.

Deprecated ⚠️ β€” yes bestie, it's deprecated. Not canceled, but deprecated. Be aware.

This info event is sent by the LIN hardware and transports bus statistics πŸšŒπŸ“Š. That's the whole point of it.


πŸŽ€ Member Function Documentation πŸŽ€

πŸ’– calculateObjectSize πŸ’–

uint32_t Vector::BLF::LinStatisticEvent::calculateObjectSize () const

[override], [virtual] β€” Calculates the objectSize ✨.

  • Returns: object size πŸ“¦
  • Reimplemented from Vector::BLF::ObjectHeaderBase.

πŸ’– read πŸ’–

void Vector::BLF::LinStatisticEvent::read (AbstractFile & is)

[override], [virtual] β€” Read the data of this object πŸ‘€.

  • Parameters: is input stream πŸ“₯
  • Reimplemented from Vector::BLF::ObjectHeaderBase.

πŸ’– write πŸ’–

void Vector::BLF::LinStatisticEvent::write (AbstractFile & os)

[override], [virtual] β€” Write the data of this object ✍️.

  • Parameters: os output stream πŸ“€
  • Reimplemented from Vector::BLF::ObjectHeaderBase.

πŸ“ Member Data Documentation πŸ“

  • uint32_t Vector::BLF::LinStatisticEvent::burstsOverrun {} β€” bursts overrun: Number of overrun bursts πŸƒβ€β™€οΈπŸ’¨
  • uint32_t Vector::BLF::LinStatisticEvent::burstsTotal {} β€” bursts total: Total number of bursts βš‘πŸ”’
  • double Vector::BLF::LinStatisticEvent::busLoad {} β€” bus load: Bus load in percents πŸšŒπŸ“ˆ
  • uint16_t Vector::BLF::LinStatisticEvent::channel {} β€” application channel: Channel number where the frame sent/received πŸ’ŒπŸ“‘
  • uint32_t Vector::BLF::LinStatisticEvent::framesReceived {} β€” frames received: Number of received frames πŸ“¬
  • uint32_t Vector::BLF::LinStatisticEvent::framesSent {} β€” frames sent: Number of transmitted frames βœ‰οΈ
  • uint32_t Vector::BLF::LinStatisticEvent::framesUnanswered {} β€” frames unanswered: Number of frames without response 😭
  • uint16_t Vector::BLF::LinStatisticEvent::reservedLinStatisticEvent1 {} β€” reserved πŸ™ˆ
  • uint32_t Vector::BLF::LinStatisticEvent::reservedLinStatisticEvent2 {} β€” reserved πŸ’€
  • uint32_t Vector::BLF::LinStatisticEvent::reservedLinStatisticEvent3 {} β€” reserved πŸ‘‘

πŸ‘‘ Author πŸ‘‘

Generated automatically by Doxygen for Vector BLF from the source code πŸ€–πŸ’…. It's giving auto-generated icon behavior, and honestly? Slay.


mwah πŸ’‹ β€” this page's source/version is Vector BLF, the footer vibe is Vector::BL...isticEvent(3), and the original footer has no date shown, so I'm not inventing one bestie 🫢✨.

πŸ“¦ where this page comes from