VECTOR_BLF_FLEXRAYVFRRECEIVEMSG(3)

📦 version 2.4.2, in arch rolling

💖 Vector::BLF::FlexRayVFrReceiveMsg 💖

okay so welcome to the Vector BLF manual, page Vector::BL...rReceiveMsg(3) — this is the FR_RCVMESSAGE class, and it's giving “FlexRay message received or transmitted on FlexRay bus” main character energy. no cap. 🦋

✨ NAME ✨

Vector::BLF::FlexRayVFrReceiveMsg — FR_RCVMESSAGE.

🌸 SYNOPSIS 🌸

#include <FlexRayVFrReceiveMsg.h>

Inherits Vector::BLF::ObjectHeader. (yes bestie, that inheritance is iconic and we're keeping it.)

💅 Public Member Functions 💅

  • void read (AbstractFile &is) override — reads the data, fr fr.
  • void write (AbstractFile &os) override — writes the data.
  • uint32_t calculateObjectSize () const override — calculates the 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. Application channel, bestie.
  • uint16_t version {} — version of data struct.
  • uint16_t channelMask {} — channel mask. Channel Mask, and the values are:
    • 0 = Reserved or invalid
    • 1 = FlexRay Channel A
    • 2 = FlexRay Channel B
    • 3 = FlexRay Channels A and B
  • uint8_t dir {} — dir flag (tx, rx). Direction Flags:
    • 0 = Rx
    • 1 = Tx
    • 2 = Tx Request
    • 3 and 4 are for internal use only.
  • uint8_t reservedFlexRayVFrReceiveMsg1 {} — reserved.
  • uint32_t clientIndexFlexRayVFrReceiveMsg {} — clientindex of send node. Client index of send node. Must be set to 0 if file is written from other applications.
  • uint32_t clusterNo {} — number of cluster. Number of cluster: channel number - 1.
  • uint16_t frameId {} — slot identifier, word. Slot identifier.
  • uint16_t headerCrc1 {} — header crc channel 1. Header CRC FlexRay channel 1 (A).
  • uint16_t headerCrc2 {} — header crc channel 2. Header CRC FlexRay channel 2 (B).
  • uint16_t byteCount {} — byte count (not payload) of frame from CC receive buffer. Payload length in bytes.
  • uint16_t dataCount {} — length of the data array (stretchy struct). Number of bytes of the payload stored in dataBytes. If the CC-frame buffer was too small to receive the complete payload, then dataCount is smaller than byteCount.
  • uint8_t cycle {} — current cycle. Cycle number.
  • uint8_t reservedFlexRayVFrReceiveMsg2 {} — reserved.
  • uint32_t tag {} — type of cc. Type of communication controller:
    • 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)
  • uint32_t data {} — frame flags. Description of frame flags:
    • Bit 0: 1 = Null frame.
    • Bit 1: 1 = Data segment contains valid data
    • Bit 2: 1 = Sync bit
    • Bit 3: 1 = Startup flag
    • Bit 4: 1 = Payload preamble bit
    • Bit 5: 1 = Reserved bit
    • Bit 6: 1 = Error flag (error frame or invalid frame)
    • Bit 7: Reserved
    • Bit 8: Internally used in CANoe/CANalyzer
    • Bit 9: Internally used in CANoe/CANalyzer
    • Bit 10: Internally used in CANoe/CANalyzer
    • Bit 11: Internally used in CANoe/CANalyzer
    • Bit 12: Internally used in CANoe/CANalyzer
    • Bit 13: Internally used in CANoe/CANalyzer
    • Bit 14: Internally used in CANoe/CANalyzer
    • Bit 15: 1 = Async. monitoring has generated this event
    • Bit 16: 1 = Event is a PDU
    • Bit 17: Valid for PDUs only. The bit is set if the PDU is valid (either if the PDU has no update bit, or the update bit for the PDU was set in the received frame).
    • Bit 18: Reserved
    • Bit 19: 1 = Raw frame (only valid if PDUs are used in the configuration). A raw frame may contain PDUs in its payload
    • Bit 20: 1 = Dynamic segment 0 = Static segment
    • Bit 21: This flag is only valid for frames and not for PDUs. 1 = The PDUs in the payload of this frame are logged in separate logging entries. 0 = The PDUs in the payload of this frame must be extracted out of this frame. The logging file does not contain separate PDU-entries.
    • Bit 22: Valid for PDUs only. The bit is set if the PDU has an update bit

The reserved bits and the bits which are for internally CANoe/CANalyzer usage must be ignored from other applications. Other applications must set these bits to 0 when writing logging files.

  • uint32_t frameFlags {} — frame flags. Description of frame flags:
    • Bit 0: 1 = Null frame.
    • Bit 1: 1 = Data segment contains valid data
    • Bit 2: 1 = Sync bit
    • Bit 3: 1 = Startup flag
    • Bit 4: 1 = Payload preamble bit
    • Bit 5: 1 = Reserved bit
    • Bit 6: 1 = Error flag (error frame or invalid frame)
    • Bit 7: Reserved
    • Bit 8: Internally used in CANoe/CANalyzer
    • Bit 9: Internally used in CANoe/CANalyzer
    • Bit 10: Internally used in CANoe/CANalyzer
    • Bit 11: Internally used in CANoe/CANalyzer
    • Bit 12: Internally used in CANoe/CANalyzer
    • Bit 13: Internally used in CANoe/CANalyzer
    • Bit 14: Internally used in CANoe/CANalyzer
    • Bit 15: 1 = Async. monitoring has generated this event
    • Bit 16: 1 = Event is a PDU
    • Bit 17: Valid for PDUs only. The bit is set if the PDU is valid (either if the PDU has no update bit, or the update bit for the PDU was set in the received frame).
    • Bit 18: Reserved
    • Bit 19: 1 = Raw frame (only valid if PDUs are used in the configuration). A raw frame may contain PDUs in its payload
    • Bit 20: 1 = Dynamic segment 0 = Static segment
    • Bit 21: This flag is only valid for frames and not for PDUs. 1 = The PDUs in the payload of this frame are logged in separate logging entries. 0 = The PDUs in the payload of this frame must be extracted out of this frame. The logging file does not contain separate PDU-entries.
    • Bit 22: Valid for PDUs only. The bit is set if the PDU has an update bit

The reserved bits and the bits which are for internally CANoe/CANalyzer usage must be ignored from other applications. Other applications must set these bits to 0 when writing logging files.

  • uint32_t appParameter {} — TxRq, TxAck flags. Not used, reserved.
  • std::array< uint8_t, 254 > dataBytes {} — array of databytes. Payload.
  • uint16_t reservedFlexRayVFrReceiveMsg3 {} — reserved.
  • uint32_t reservedFlexRayVFrReceiveMsg4 {} — reserved.

💜 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 🔥

FR_RCVMESSAGE.

FlexRay message received or transmitted on FlexRay bus.

⭐ Member Function Documentation ⭐

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

[override], [virtual]

Calculates the objectSize.

Returns: object size.

Reimplemented from Vector::BLF::ObjectHeaderBase.

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

[override], [virtual]

Read the data of this object.

Parameters: is input stream.

Reimplemented from Vector::BLF::ObjectHeaderBase.

void Vector::BLF::FlexRayVFrReceiveMsg::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::FlexRayVFrReceiveMsg::appParameter {}

TxRq, TxAck flags. Not used, reserved.

uint16_t Vector::BLF::FlexRayVFrReceiveMsg::byteCount {}

byte count (not payload) of frame from CC receive buffer. Payload length in bytes.

uint16_t Vector::BLF::FlexRayVFrReceiveMsg::channel {}

application channel. Application channel.

uint16_t Vector::BLF::FlexRayVFrReceiveMsg::channelMask {}

channel mask. Channel Mask:

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

uint32_t Vector::BLF::FlexRayVFrReceiveMsg::clientIndexFlexRayVFrReceiveMsg {}

clientindex of send node. Client index of send node. Must be set to 0 if file is written from other applications.

uint32_t Vector::BLF::FlexRayVFrReceiveMsg::clusterNo {}

number of cluster. Number of cluster: channel number - 1.

uint8_t Vector::BLF::FlexRayVFrReceiveMsg::cycle {}

current cycle. Cycle number.

uint32_t Vector::BLF::FlexRayVFrReceiveMsg::data {}

frame flags. Description of frame flags:

  • Bit 0: 1 = Null frame.
  • Bit 1: 1 = Data segment contains valid data
  • Bit 2: 1 = Sync bit
  • Bit 3: 1 = Startup flag
  • Bit 4: 1 = Payload preamble bit
  • Bit 5: 1 = Reserved bit
  • Bit 6: 1 = Error flag (error frame or invalid frame)
  • Bit 7: Reserved
  • Bit 8: Internally used in CANoe/CANalyzer
  • Bit 9: Internally used in CANoe/CANalyzer
  • Bit 10: Internally used in CANoe/CANalyzer
  • Bit 11: Internally used in CANoe/CANalyzer
  • Bit 12: Internally used in CANoe/CANalyzer
  • Bit 13: Internally used in CANoe/CANalyzer
  • Bit 14: Internally used in CANoe/CANalyzer
  • Bit 15: 1 = Async. monitoring has generated this event
  • Bit 16: 1 = Event is a PDU
  • Bit 17: Valid for PDUs only. The bit is set if the PDU is valid (either if the PDU has no update bit, or the update bit for the PDU was set in the received frame).
  • Bit 18: Reserved
  • Bit 19: 1 = Raw frame (only valid if PDUs are used in the configuration). A raw frame may contain PDUs in its payload
  • Bit 20: 1 = Dynamic segment 0 = Static segment
  • Bit 21: This flag is only valid for frames and not for PDUs. 1 = The PDUs in the payload of this frame are logged in separate logging entries. 0 = The PDUs in the payload of this frame must be extracted out of this frame. The logging file does not contain separate PDU-entries.
  • Bit 22: Valid for PDUs only. The bit is set if the PDU has an update bit

The reserved bits and the bits which are for internally CANoe/CANalyzer usage must be ignored from other applications. Other applications must set these bits to 0 when writing logging files.

std::array<uint8_t, 254> Vector::BLF::FlexRayVFrReceiveMsg::dataBytes {}

array of databytes. Payload.

uint16_t Vector::BLF::FlexRayVFrReceiveMsg::dataCount {}

length of the data array (stretchy struct). Number of bytes of the payload stored in dataBytes. If the CC-frame buffer was too small to receive the complete payload, then dataCount is smaller than byteCount.

uint8_t Vector::BLF::FlexRayVFrReceiveMsg::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::FlexRayVFrReceiveMsg::frameFlags {}

frame flags. Description of frame flags:

  • Bit 0: 1 = Null frame.
  • Bit 1: 1 = Data segment contains valid data
  • Bit 2: 1 = Sync bit
  • Bit 3: 1 = Startup flag
  • Bit 4: 1 = Payload preamble bit
  • Bit 5: 1 = Reserved bit
  • Bit 6: 1 = Error flag (error frame or invalid frame)
  • Bit 7: Reserved
  • Bit 8: Internally used in CANoe/CANalyzer
  • Bit 9: Internally used in CANoe/CANalyzer
  • Bit 10: Internally used in CANoe/CANalyzer
  • Bit 11: Internally used in CANoe/CANalyzer
  • Bit 12: Internally used in CANoe/CANalyzer
  • Bit 13: Internally used in CANoe/CANalyzer
  • Bit 14: Internally used in CANoe/CANalyzer
  • Bit 15: 1 = Async. monitoring has generated this event
  • Bit 16: 1 = Event is a PDU
  • Bit 17: Valid for PDUs only. The bit is set if the PDU is valid (either if the PDU has no update bit, or the update bit for the PDU was set in the received frame).
  • Bit 18: Reserved
  • Bit 19: 1 = Raw frame (only valid if PDUs are used in the configuration). A raw frame may contain PDUs in its payload
  • Bit 20: 1 = Dynamic segment 0 = Static segment
  • Bit 21: This flag is only valid for frames and not for PDUs. 1 = The PDUs in the payload of this frame are logged in separate logging entries. 0 = The PDUs in the payload of this frame must be extracted out of this frame. The logging file does not contain separate PDU-entries.
  • Bit 22: Valid for PDUs only. The bit is set if the PDU has an update bit

The reserved bits and the bits which are for internally CANoe/CANalyzer usage must be ignored from other applications. Other applications must set these bits to 0 when writing logging files.

uint16_t Vector::BLF::FlexRayVFrReceiveMsg::frameId {}

slot identifier, word. Slot identifier.

uint16_t Vector::BLF::FlexRayVFrReceiveMsg::headerCrc1 {}

header crc channel 1. Header CRC FlexRay channel 1 (A).

uint16_t Vector::BLF::FlexRayVFrReceiveMsg::headerCrc2 {}

header crc channel 2. Header CRC FlexRay channel 2 (B).

uint8_t Vector::BLF::FlexRayVFrReceiveMsg::reservedFlexRayVFrReceiveMsg1 {}

reserved.

uint8_t Vector::BLF::FlexRayVFrReceiveMsg::reservedFlexRayVFrReceiveMsg2 {}

reserved.

uint16_t Vector::BLF::FlexRayVFrReceiveMsg::reservedFlexRayVFrReceiveMsg3 {}

reserved.

uint32_t Vector::BLF::FlexRayVFrReceiveMsg::reservedFlexRayVFrReceiveMsg4 {}

reserved.

uint32_t Vector::BLF::FlexRayVFrReceiveMsg::tag {}

type of cc. Type of communication controller:

  • 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)

uint16_t Vector::BLF::FlexRayVFrReceiveMsg::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! 💖 Cute sign-off time: this is the Vector BLF manual, page Vector::BL...rReceiveMsg(3), and the footer/source check is Vector BLF — generated by Doxygen from the source code. There’s no date printed in the footer, so I’m not inventing one, periodt. 🎀

📦 where this page comes from