VECTOR_BLF_J1708MESSAGE(3)

๐Ÿ“ฆ version 2.4.2, in arch rolling

๐Ÿ’œ Vector::BLF::J1708Message(3) ๐Ÿ’œ

okay so this is a page from the Library Functions Manual (yes that's literally the manual name, slay) and it's all about Vector::BLF::J1708Message, bestie. buckle up ๐ŸŽ€


โœจ NAME โœจ

Vector::BLF::J1708Message โ€” ngl it's giving J1708_MESSAGE, J1708_VIRTUAL_MSG. that's the whole vibe check right there ๐Ÿ’…


๐ŸŒธ SYNOPSIS ๐ŸŒธ

#include <J1708Message.h>

Inherits Vector::BLF::ObjectHeader. so it's part of the family tree, main character energy but with a whole inheritance situation going on ๐Ÿซถ

๐Ÿฆ‹ Public Member Functions

  • void read(AbstractFile &is) override โ€” reads stuff in
  • void write(AbstractFile &os) override โ€” writes stuff out
  • uint32_t calculateObjectSize() const override โ€” does the math on how big the object is

๐Ÿ’ซ Public Member Functions inherited from Vector::BLF::ObjectHeader

  • ObjectHeader(const ObjectType objectType, const uint16_t objectVersion=0) โ€” constructor tingz
  • 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

  • uint16_t channel {} โ€” application channel ๐Ÿ“ก
  • uint8_t dir {} โ€” direction (which way bestie is going)
  • uint8_t reservedJ1708Message1 {} โ€” reserved, don't touch, iykyk
  • uint16_t error {} โ€” error code ๐Ÿ˜ญ
  • uint8_t size {} โ€” data size
  • std::array< uint8_t, 255 > data {} โ€” the actual data, 255 of them, iconic
  • uint16_t reservedJ1708Message2 {} โ€” also reserved, also don't touch

๐Ÿ’ซ 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 (that's literally ObjectSignature, no cap)
  • 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 }

two whole flags, 0x00000001 and 0x00000002, we love a numbered moment โœจ


๐Ÿ”ฅ Detailed Description ๐Ÿ”ฅ

J1708_MESSAGE, J1708_VIRTUAL_MSG.

J1708 message object. that's it, that's the description, she's brief and she knows it ๐Ÿ’…


๐Ÿ‘‘ Member Function Documentation ๐Ÿ‘‘

๐Ÿ’– uint32_t Vector::BLF::J1708Message::calculateObjectSize() const [override], [virtual]

Calculates the objectSize. literally does the math so you don't have to ๐Ÿงฎ

Returns object size โ€” yeah, that's the return, that's the whole thing

Reimplemented from Vector::BLF::ObjectHeaderBase.

๐Ÿ’– void Vector::BLF::J1708Message::read(AbstractFile &is) [override], [virtual]

Read the data of this object. feed her input and she'll eat, periodt ๐Ÿ“

Parameters is โ€” input stream

Reimplemented from Vector::BLF::ObjectHeaderBase.

๐Ÿ’– void Vector::BLF::J1708Message::write(AbstractFile &os) [override], [virtual]

Write the data of this object. she's got something to say and she's saying it ๐Ÿ“ค

Parameters os โ€” output stream

Reimplemented from Vector::BLF::ObjectHeaderBase.


๐ŸŽ€ Member Data Documentation ๐ŸŽ€

โญ uint8_t Vector::BLF::J1708Message::reservedJ1708Message1 {}

reserved. hands off, bestie ๐Ÿ™ˆ

โญ uint16_t Vector::BLF::J1708Message::reservedJ1708Message2 {}

reserved. same energy, different type ๐Ÿ’€


๐ŸŒท Author ๐ŸŒท

Generated automatically by Doxygen for Vector BLF from the source code. not a human wrote this, a robot did, and honestly? she ate ๐Ÿค–๐Ÿ’–


real talk though: everything above came straight from the manual โ€” the inheritance chains, the exact types, the {} defaults, the 0x00000001 / 0x00000002 flags, all of it. no details were harmed in the making of this rewrite ๐Ÿซถ

and that's the page, bestie! this one's from the Vector BLF docs โ€” shoutout to whoever ran Doxygen on that source code, and to you for reading the whole thing. mwah ๐Ÿ’‹ bye bye, go read some more manpages, you icon โœจ๐Ÿ’œ๐Ÿฆ‹

๐Ÿ“ฆ where this page comes from