Vector::BL...tFrameData(3)

πŸ“¦ version 2.4.2, in arch rolling

πŸ’… Vector::BLF::CanFdExtFrameData ✨

okay so bestie, we're in the Library Functions Manual today and the main character is Vector::BLF::CanFdExtFrameData β€” no cap, this is the glow-up page for it. 🫢


πŸŽ€ NAME πŸŽ€

Vector::BLF::CanFdExtFrameData β€” literally the class, that's the name, we're not doing a whole paragraph about it πŸ’–


✨ SYNOPSIS ✨

#include <CanFdExtFrameData.h>

Inherited by Vector::BLF::CanFdErrorFrame64, and Vector::BLF::CanFdMessage64. πŸ‘‘

🌸 Public Member Functions 🌸

these are the moves it can do, and yes they're mostly defaulted, she's lowkey low-maintenance:

  • CanFdExtFrameData (const CanFdExtFrameData &)=default β€” copy constructor, defaulted, slay
  • CanFdExtFrameData & operator= (const CanFdExtFrameData &)=default β€” copy assignment, also defaulted
  • CanFdExtFrameData (CanFdExtFrameData &&)=default β€” move constructor, defaulted
  • CanFdExtFrameData & operator= (CanFdExtFrameData &&)=default β€” move assignment, defaulted
  • virtual void read (AbstractFile &is) β€” reads stuff
  • virtual void write (AbstractFile &os) β€” writes stuff
  • virtual uint32_t calculateObjectSize () const β€” does math on the size

πŸ¦‹ Public Attributes πŸ¦‹

  • uint32_t btrExtArb {}
  • uint32_t btrExtData {}
  • std::vector< uint8_t > reservedCanFdExtFrameData {}

πŸ’œ Detailed Description πŸ’œ

it's giving optional information in the CanFdMessage64 and CanFdErrorFrame64 classes. like, the extra little lore, yk? πŸ’€


πŸ‘‘ Member Function Documentation πŸ‘‘

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

[virtual]

calculates the objectSize. that's the whole job. iconic honestly.

Returns object size

Reimplemented in Vector::BLF::CanFdErrorFrame64, and Vector::BLF::CanFdMessage64.

🧚 void Vector::BLF::CanFdExtFrameData::read (AbstractFile & is) [virtual]

read the data of this object, bestie. pull it in.

Parameters is β€” input stream

Reimplemented in Vector::BLF::CanFdErrorFrame64, and Vector::BLF::CanFdMessage64.

🧚 void Vector::BLF::CanFdExtFrameData::write (AbstractFile & os) [virtual]

write the data of this object. push it back out. ✨

Parameters os β€” output stream

Reimplemented in Vector::BLF::CanFdErrorFrame64, and Vector::BLF::CanFdMessage64.


πŸ’– Member Data Documentation πŸ’–

🌈 uint32_t Vector::BLF::CanFdExtFrameData::btrExtArb {}

bit rate in arbitration phase. okay so the bits are doing a whole thing here:

  • Bit 0-7: TSEG1-1
  • Bit 8-15: TSEG2-1
  • Bit 16-27: Prescaler
  • Bit 28-31: Quartz Frequency (enumeration). Supported values:
    • 0: 16 MHz
    • 1: 32 MHz
    • 2: 80 MHz

🌈 uint32_t Vector::BLF::CanFdExtFrameData::btrExtData {}

bit rate in data phase. and the layout is serving the exact same, no cap:

  • Bit 0-7: TSEG1-1
  • Bit 8-15: TSEG2-1
  • Bit 16-27: Prescaler
  • Bit 28-31: Quartz Frequency (enumeration). Supported values:
    • 0: 16 MHz
    • 1: 32 MHz
    • 2: 80 MHz

🌈 std::vector<uint8_t> Vector::BLF::CanFdExtFrameData::reservedCanFdExtFrameData {}

reserved. that's it. she's reserved. πŸ™ˆ (fr fr that's the entire description πŸ’€)


πŸ“ Author πŸ“

Generated automatically by Doxygen for Vector BLF from the source code. yes bestie, nobody hand-wrote this, it manifested.


lowkey a reminder that this whole page is auto-generated, so don't come for the prose, come for Doxygen 🫢

πŸ’… and that's the page! brought to you by Vector BLF and its Vector::BL...tFrameData(3) manual page β€” mwah, go read the real thing, periodt. πŸ’œ

πŸ“¦ where this page comes from