VECTOR_BLF_FLEXRAYV6MESSAGE(3)

πŸ“¦ version 2.4.2, in arch rolling

πŸ’– NAME πŸ’–

Bestie, welcome to the Vector::BL...ayV6Message(3) page from the Library Functions Manual ✨ The main character here is Vector::BLF::FlexRayV6Message β€” aka FLEXRAY_MESSAGE. That's literally the name, no cap.


✨ SYNOPSIS ✨

Okay so first, include the header:

#include <FlexRayV6Message.h>

It inherits Vector::BLF::ObjectHeader πŸ’…

πŸŽ€ 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 πŸ“

  • uint16_t channel {} β€” application channel. Yes, the Application channel, bestie πŸ’–
  • uint8_t dir {} β€” dir flag (tx, rx).
  • uint8_t lowTime {} β€” additional time field in simulation. (Additional time field in simulation, periodt.)
  • uint32_t fpgaTick {} β€” timestamp generated from xModule. (Timestamp generated from xModule ✨)
  • uint32_t fpgaTickOverflow {} β€” overflow counter of the timestamp. (Overflow counter of the timestamp πŸ”₯)
  • uint32_t clientIndexFlexRayV6Message {} β€” clientindex of send node. (Client index of send node πŸ‘‘)
  • uint32_t clusterTime {} β€” relatvie clustertime, from 0 to cyclelength. (Relatvie clustertime, from 0 to cyclelength β€” yes, that spelling is exact, iykyk πŸ™ˆ)
  • uint16_t frameId {} β€” slot identifier.
  • uint16_t headerCrc {} β€” no extra description in the source; it's just here doing its thing πŸ’…
  • uint16_t frameState {} β€” V6 framestate.
  • uint8_t length {} β€” dlc of message.
  • uint8_t cycle {} β€” current cycle.
  • uint8_t headerBitMask {} β€” Bit0 = NMBit, Bit1 = SyncBit, Bit2 = Reserved.
  • uint8_t reservedFlexRayV6Message1 {} β€” reserved.
  • uint16_t reservedFlexRayV6Message2 {} β€” reserved.
  • std::array< uint8_t, 64 > dataBytes {} β€” array of databytes.

πŸ’œ 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.

✨ Additional Inherited Members ✨

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

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

🌸 Detailed Description 🌸

Ok so this is FLEXRAY_MESSAGE πŸ’– A FlexRay Message received or transmitted on a FlexRay channel. That's the whole vibe: received or transmitted, on a FlexRay channel. Slay.


πŸ’… Member Function Documentation πŸ’…

πŸ¦‹ uint32_t Vector::BLF::FlexRayV6Message::calculateObjectSize () const

[override], [virtual]

Calculates the objectSize ✨

Returns: object size.

Reimplemented from Vector::BLF::ObjectHeaderBase.

πŸ¦‹ void Vector::BLF::FlexRayV6Message::read (AbstractFile & is) [override], [virtual]

Read the data of this object πŸ’–

Parameters:

  • is β€” input stream.

Reimplemented from Vector::BLF::ObjectHeaderBase.

πŸ¦‹ void Vector::BLF::FlexRayV6Message::write (AbstractFile & os) [override], [virtual]

Write the data of this object ✨

Parameters:

  • os β€” output stream.

Reimplemented from Vector::BLF::ObjectHeaderBase.


πŸ“ Member Data Documentation πŸ“

  • uint16_t Vector::BLF::FlexRayV6Message::channel {} β€” application channel / Application channel.
  • uint32_t Vector::BLF::FlexRayV6Message::clientIndexFlexRayV6Message {} β€” clientindex of send node / Client index of send node.
  • uint32_t Vector::BLF::FlexRayV6Message::clusterTime {} β€” relatvie clustertime, from 0 to cyclelength / Relatvie clustertime, from 0 to cyclelength.
  • uint8_t Vector::BLF::FlexRayV6Message::cycle {} β€” current cycle / Current cycle number.
  • std::array<uint8_t, 64> Vector::BLF::FlexRayV6Message::dataBytes {} β€” array of databytes / Payload.
  • uint8_t Vector::BLF::FlexRayV6Message::dir {} β€” dir flag (tx, rx) / Direction Flags:
    • 0 = Rx
    • 1 = Tx
    • 2 = Tx Request
    • 3 and 4 are for internal use only.
  • uint32_t Vector::BLF::FlexRayV6Message::fpgaTick {} β€” timestamp generated from xModule / Timestamp generated from xModule.
  • uint32_t Vector::BLF::FlexRayV6Message::fpgaTickOverflow {} β€” overflow counter of the timestamp / Overflow counter of the timestamp.
  • uint16_t Vector::BLF::FlexRayV6Message::frameId {} β€” slot identifier / slot identifier.
  • uint16_t Vector::BLF::FlexRayV6Message::frameState {} β€” V6 framestate. / V6 framestate:
    • 0 Payload preample indicator bit
    • 1 Sync. frame indicator
    • 2 Reserved bit
    • 3 Null frame indicator
    • 4 Startup frame indicator
    • 5-7 Frame state format mask (see below)

Bit 5-7 meaning:

  • 0 (0x00) Motorola V.6
  • 1 (0x20) reserved
  • 2 (0x40) BusDoctor
  • 3 (0x60) reserved
  • 4 (0x80) FlexCard Cyclone
  • 5 (0xA0) reserved
  • 6 (0xC0) reserved
  • 7 (0xE0) reserved
  • uint8_t Vector::BLF::FlexRayV6Message::headerBitMask {} β€” Bit0 = NMBit, Bit1 = SyncBit, Bit2 = Reserved. The source also spells it out as:
    • Bit 0 = NMBit
    • Bit 1 = SyncBit
    • Bit 2 = Reserved
  • uint16_t Vector::BLF::FlexRayV6Message::headerCrc {} β€” CRC of the frame header.
  • uint8_t Vector::BLF::FlexRayV6Message::length {} β€” dlc of message / Payload length.
  • uint8_t Vector::BLF::FlexRayV6Message::lowTime {} β€” additional time field in simulation / Additional time field in simulation.
  • uint8_t Vector::BLF::FlexRayV6Message::reservedFlexRayV6Message1 {} β€” reserved.
  • uint16_t Vector::BLF::FlexRayV6Message::reservedFlexRayV6Message2 {} β€” reserved.

πŸ‘‘ Author πŸ‘‘

Generated automatically by Doxygen for Vector BLF from the source code. Iconic behavior, honestly 🫢

πŸ’œ Cute sign-off: source/version is Vector BLF, page tag is Vector::BL...ayV6Message(3), and the original footer doesn’t show a date β€” just vibes and the manual tag, bestie. πŸ’œ

πŸ“¦ where this page comes from