VECTOR_BLF_FLEXRAYVFRSTARTCYCLE(3)

📦 version 2.4.2, in arch rolling

🦋 NAME 🦋

Vector::BLF::FlexRayVFrStartCycle — okay bestie, this is the whole FR_STARTCYCLE situation, like the actual class for it. Think of it as the glow-up of a FlexRay StartCycle event, courtesy of Vector BLF.

✨ SYNOPSIS ✨

Okay so first up, you gotta bring this header into the group chat:

#include <FlexRayVFrStartCycle.h>

And here's the family tree moment: this class Inherits Vector::BLF::ObjectHeader (which like, itself inherits from Vector::BLF::ObjectHeaderBase, so it's giving main character energy all the way down, iykyk).

🫶 Public Member Functions

These are the three you actually call, no cap:

  • void read(AbstractFile &is) override — slurps the data of this object right up
  • void write(AbstractFile &os) override — pushes the data of this object out
  • uint32_t calculateObjectSize() const override — does the math for objectSize

🧚 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
  • uint16_t version {} — version of data struct
  • uint16_t channelMask {} — channel mask
  • uint8_t dir {} — dir flag (tx, rx)
  • uint8_t cycle {} — current cycle
  • uint32_t clientIndexFlexRayVFrStartCycle {} — clientindex of send node
  • uint32_t clusterNo {} — number of cluster
  • uint16_t nmSize {} — size of NM Vector
  • std::array< uint8_t, 12 > dataBytes {} — array of databytes (NM vector max. length)
  • uint16_t reservedFlexRayVFrStartCycle1 {}
  • uint32_t tag {} — type of cc
  • std::array< uint32_t, 5 > data {} — register flags
  • uint64_t reservedFlexRayVFrStartCycle2 {}

🍓 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 — the options are:
    • TimeTenMics = 0x00000001
    • TimeOneNans = 0x00000002

🌟 Detailed Description 🌟

FR_STARTCYCLE.

Literally exactly what it sounds like, bestie: a FlexRay StartCycle event transmitted by the FlexRay hardware. That's the vibe. 🎀

💖 Member Function Documentation 💖

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

[override], [virtual]

Okay so this one Calculates the objectSize. That's it, that's the job. Iconic, no notes.

Returns: the object size ✨

Reimplemented from Vector::BLF::ObjectHeaderBase.

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

[override], [virtual]

Read the data of this object. Slay.

Parameters:

  • is — input stream

Reimplemented from Vector::BLF::ObjectHeaderBase.

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

[override], [virtual]

Write the data of this object. Periodt.

Parameters:

  • os — output stream

Reimplemented from Vector::BLF::ObjectHeaderBase.

🎀 Member Data Documentation 🎀

uint16_t Vector::BLF::FlexRayVFrStartCycle::channel {}

Application channel. Application channel. (Yes bestie they said it twice, we move.)

uint16_t Vector::BLF::FlexRayVFrStartCycle::channelMask {}

Channel mask. Channel Mask, and the options are giving:

  • 0 = Reserved or invalid
  • 1 = FlexRay Channel A
  • 2 = FlexRay Channel B
  • 3 = FlexRay Channels A and B

uint32_t Vector::BLF::FlexRayVFrStartCycle::clientIndexFlexRayVFrStartCycle {}

Clientindex of send node. Client index of send node. (the name is long but she's worth it 💅)

uint32_t Vector::BLF::FlexRayVFrStartCycle::clusterNo {}

Number of cluster. Number of cluster: channel number - 1. Math is mathing.

uint8_t Vector::BLF::FlexRayVFrStartCycle::cycle {}

Current cycle. Cycle number. Go off.

std::array<uint32_t, 5> Vector::BLF::FlexRayVFrStartCycle::data {}

Register flags. Driver flags for internal usage — okay so this one has layers, pay attention:

Cyclone I:

  • 0: Rate correction of CC, read from RCVR register
  • 1: Offset correction of CC, read from OCVR register

Cyclone II:

  • 0: Sync correction of CC, read from RCV register
  • 1: Offset correction of CC, read from OCV register
  • 2: Cycles with no correction, read from CCEV register
  • 3: Cycles with correction in passive mode, read from CCEV register
  • 4: Sync Frame status, read from SFS register

VN-Interface:

  • 0: Sync correction of CC, read from RCV register
  • 1: Offset correction of CC, read from OCV register
  • 2: Cycles with no correction, read from CCEV register
  • 3: Cycles with correction in passive mode, read from CCEV register
  • 4: Sync Frame status, read from SFS register

std::array<uint8_t, 12> Vector::BLF::FlexRayVFrStartCycle::dataBytes {}

Array of databytes (NM vector max. length). Array of databytes (NM vector max. length). Twelve bytes of pure potential ✨

uint8_t Vector::BLF::FlexRayVFrStartCycle::dir {}

Dir flag (tx, rx). Direction Flags, and the list is:

  • 0 = Rx
  • 1 = Tx
  • 2 = Tx Request
  • 3 and 4 are for internal use only.
👀 Heads up bestie: if you're poking at 3 and 4, those are for internal use only. Don't @ them.

uint16_t Vector::BLF::FlexRayVFrStartCycle::nmSize {}

Size of NM Vector. Length of NM-Vector in bytes. Short and sweet 🍓

uint16_t Vector::BLF::FlexRayVFrStartCycle::reservedFlexRayVFrStartCycle1 {}

Reserved. (lowercase reserved, very chill of them)

uint64_t Vector::BLF::FlexRayVFrStartCycle::reservedFlexRayVFrStartCycle2 {}

Reserved. (capital R this time, fancy)

uint32_t Vector::BLF::FlexRayVFrStartCycle::tag {}

Type of cc. Type of communication controller, and the whole menu is:

  • 0 = Architecture independent
  • 1 = Invalid CC type (for internal use only)
  • 2 = Cyclone I
  • 3 = BUSDOCTOR
  • 4 = Cyclone II
  • 5 = Vector VN interface
  • 6 = VN-Sync-Pulse (only in Status Event, for debugging purposes only)
💀 Don't sleep on the fine print: 1 is for internal use only, and 6 only shows up in Status Event, for debugging purposes only. Noted, periodt.

uint16_t Vector::BLF::FlexRayVFrStartCycle::version {}

Version of data struct. Object version, for internal use. 🫶

👑 Author 👑

Generated automatically by Doxygen for Vector BLF from the source code.

Okay that's the whole page bestie, you ate that 💅✨ — and just so we're cute and complete: this was brought to you by Vector BLF, the page being Vector::BLF::FlexRayVFrStartCycle(3). Mwah, go slay some FlexRay 💖🦋🌸

📦 where this page comes from