Vector BLF
Vector::BLF::FlexRayVFrReceiveMsgEx Struct Referencefinal

FR_RCVMESSAGE_EX. More...

#include <FlexRayVFrReceiveMsgEx.h>

Inheritance diagram for Vector::BLF::FlexRayVFrReceiveMsgEx:
Inheritance graph
Collaboration diagram for Vector::BLF::FlexRayVFrReceiveMsgEx:
Collaboration graph

Public Member Functions

void read (AbstractFile &is) override
 
void write (AbstractFile &os) override
 
DWORD calculateObjectSize () const override
 
- Public Member Functions inherited from Vector::BLF::ObjectHeader
 ObjectHeader (const ObjectType objectType, const WORD objectVersion=0)
 
void read (AbstractFile &is) override
 
void write (AbstractFile &os) override
 
WORD calculateHeaderSize () const override
 
DWORD calculateObjectSize () const override
 
- Public Member Functions inherited from Vector::BLF::ObjectHeaderBase
 ObjectHeaderBase (const WORD headerVersion, const ObjectType objectType)
 
 ObjectHeaderBase (const ObjectHeaderBase &)=default
 
ObjectHeaderBaseoperator= (const ObjectHeaderBase &)=default
 
 ObjectHeaderBase (ObjectHeaderBase &&)=default
 
ObjectHeaderBaseoperator= (ObjectHeaderBase &&)=default
 

Public Attributes

WORD channel {}
 application channel More...
 
WORD version {}
 version of data struct More...
 
WORD channelMask {}
 channel mask More...
 
WORD dir {}
 dir flag (tx, rx) More...
 
DWORD clientIndexFlexRayVFrReceiveMsgEx {}
 clientindex of send node More...
 
DWORD clusterNo {}
 number of cluster More...
 
WORD frameId {}
 slot identifier, word More...
 
WORD headerCrc1 {}
 header crc channel 1 More...
 
WORD headerCrc2 {}
 header crc channel 2 More...
 
WORD byteCount {}
 byte count (not payload) of frame from CC receive buffer More...
 
WORD dataCount {}
 length of the data array (stretchy struct) More...
 
WORD cycle {}
 current cycle More...
 
DWORD tag {}
 type of cc More...
 
DWORD data {}
 register flags More...
 
DWORD frameFlags {}
 frame flags More...
 
DWORD appParameter {}
 TxRq, TxAck flags. More...
 
DWORD frameCrc {}
 frame crc More...
 
DWORD frameLengthNs {}
 length of frame in ns More...
 
WORD frameId1 {}
 for internal use More...
 
WORD pduOffset {}
 payload offset (position in a frame) More...
 
WORD blfLogMask {}
 only valid for frames. Every stands for one PDU. If set, the PDU must be extracted out of the frame. The bit order is the PDU order in the frame starting with the PDU with the smallest offset More...
 
std::array< WORD, 13 > reservedFlexRayVFrReceiveMsgEx {}
 
std::vector< BYTE > dataBytes {}
 array of databytes More...
 
- Public Attributes inherited from Vector::BLF::ObjectHeader
DWORD objectFlags {ObjectFlags::TimeOneNans}
 object flags More...
 
WORD clientIndex {}
 client index of send node
 
WORD objectVersion {0}
 object specific version More...
 
ULONGLONG objectTimeStamp {}
 object timestamp More...
 
- Public Attributes inherited from Vector::BLF::ObjectHeaderBase
DWORD signature {ObjectSignature}
 signature (ObjectSignature) More...
 
WORD headerSize {}
 sizeof object header More...
 
WORD headerVersion {}
 header version (1) More...
 
DWORD objectSize {}
 object size More...
 
ObjectType objectType {}
 object type More...
 

Additional Inherited Members

- Public Types inherited from Vector::BLF::ObjectHeader
enum  ObjectFlags : DWORD { TimeTenMics = 0x00000001 , TimeOneNans = 0x00000002 }
 

Detailed Description

FR_RCVMESSAGE_EX.

FlexRay message or PDU received or transmitted on FlexRay bus.

Member Function Documentation

◆ calculateObjectSize()

DWORD Vector::BLF::FlexRayVFrReceiveMsgEx::calculateObjectSize ( ) const
overridevirtual

Calculates the objectSize

Returns
object size

Reimplemented from Vector::BLF::ObjectHeaderBase.

◆ read()

void Vector::BLF::FlexRayVFrReceiveMsgEx::read ( AbstractFile is)
overridevirtual

Read the data of this object

Parameters
isinput stream

Reimplemented from Vector::BLF::ObjectHeaderBase.

◆ write()

void Vector::BLF::FlexRayVFrReceiveMsgEx::write ( AbstractFile os)
overridevirtual

Write the data of this object

Parameters
osoutput stream

Reimplemented from Vector::BLF::ObjectHeaderBase.

Member Data Documentation

◆ appParameter

DWORD Vector::BLF::FlexRayVFrReceiveMsgEx::appParameter {}

TxRq, TxAck flags.

Not used, reserved

◆ blfLogMask

WORD Vector::BLF::FlexRayVFrReceiveMsgEx::blfLogMask {}

only valid for frames. Every stands for one PDU. If set, the PDU must be extracted out of the frame. The bit order is the PDU order in the frame starting with the PDU with the smallest offset

Only valid for frames. Every stands for one PDU. If set, the PDU must be extracted out of the frame. The bit order is the PDU order in the frame starting with the PDU with the smallest offset.

◆ byteCount

WORD Vector::BLF::FlexRayVFrReceiveMsgEx::byteCount {}

byte count (not payload) of frame from CC receive buffer

Payload length in bytes

◆ channel

WORD Vector::BLF::FlexRayVFrReceiveMsgEx::channel {}

application channel

Application channel

◆ channelMask

WORD Vector::BLF::FlexRayVFrReceiveMsgEx::channelMask {}

channel mask

Channel Mask

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

◆ clientIndexFlexRayVFrReceiveMsgEx

DWORD Vector::BLF::FlexRayVFrReceiveMsgEx::clientIndexFlexRayVFrReceiveMsgEx {}

clientindex of send node

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

◆ clusterNo

DWORD Vector::BLF::FlexRayVFrReceiveMsgEx::clusterNo {}

number of cluster

Number of cluster: channel number - 1

◆ cycle

WORD Vector::BLF::FlexRayVFrReceiveMsgEx::cycle {}

current cycle

Cycle number

◆ data

DWORD Vector::BLF::FlexRayVFrReceiveMsgEx::data {}

register flags

Controller specific frame state information

Cyclone I:

  • Bit 0: TX Conflict (TXCON)
  • Bit 1: Boundary Violation (BVIOL)
  • Bit 2: Content Error (CERR)
  • Bit 3: Syntax Error (SERR)
  • Bit 4: StartUP Frame indication (SUPF)
  • Bit 5: NULL Frame indication (NF)
  • Bit 6: SYNC Frame indication (SF)
  • Bit 7: Valid Communication Element (VCE)

Cyclone II:

  • Bit 0: Syntax Error (SERR)
  • Bit 1: Content Error (CERR)
  • Bit 2: Slot BoundaryViolation (BVIOL)
  • Bit 3: Empty Slot (SLEMPTY)
  • Bit 4: Message Lost (MLOST)
  • Bit 5: Valid Frame (VAL)

BUSDOCTOR:

  • Bit 0: Decoding Error (CODERR)
  • Bit 1: Violation Error (TSSVIOL)
  • Bit 2: Header CRC Error (HCRCERR)
  • Bit 3: Frame CRC Error (FCRCERR)
  • Bit 4: Frame End Sequence Error (FESERR)
  • Bit 5: Symbol (SYMB)
  • Bit 6: Valid Frame (VAL)
  • Bit 7: Boundary Violation Error (MASB)
  • Bit 8: NIT Violation Error (NITVIOL)
  • Bit 9: Symbol Window Violation Error (SWVIOL)
  • Bit 10: Slot Overbooked Error (SOVERR)
  • Bit 11: Null Frame Error (INFE)
  • Bit 12: Syncframe or Startup Error (ISFE)
  • Bit 13: Frame ID Error (FIDE)
  • Bit 14: Cycle Counter Error (CCE)
  • Bit 15: Static Payload Length Error (PLSE)

VN:

  • Bit 0: Syntax Error (SERR)
  • Bit 1: Content Error (CERR)
  • Bit 2: Slot BoundaryViolation (BVIOL)
  • Bit 3: Empty Slot (SLEMPTY)
  • Bit 4: Message Lost (MLOST)
  • Bit 5: Valid Frame (VAL)
  • Bit 6: TX Conflict (TXCON)
  • Bit 7: Framing Error (FrmERR)
  • Bit 8: Header CRC Error (HdrERR)
  • Bit 9: Frame CRC Error (FrmCRC)
  • Bit 12: Tx Conflict

◆ dataBytes

std::vector<BYTE> Vector::BLF::FlexRayVFrReceiveMsgEx::dataBytes {}

array of databytes

Payload

◆ dataCount

WORD Vector::BLF::FlexRayVFrReceiveMsgEx::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.

◆ dir

WORD Vector::BLF::FlexRayVFrReceiveMsgEx::dir {}

dir flag (tx, rx)

Direction Flags

  • 0 = Rx
  • 1 = Tx
  • 2 = Tx Request
  • 3 and 4 are for internal use only.

◆ frameCrc

DWORD Vector::BLF::FlexRayVFrReceiveMsgEx::frameCrc {}

frame crc

Frame CRC

◆ frameFlags

DWORD Vector::BLF::FlexRayVFrReceiveMsgEx::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.

◆ frameId

WORD Vector::BLF::FlexRayVFrReceiveMsgEx::frameId {}

slot identifier, word

Slot identifier

◆ frameId1

WORD Vector::BLF::FlexRayVFrReceiveMsgEx::frameId1 {}

for internal use

For PDUs only: This is the slot ID of the frame which contains this PDU

◆ frameLengthNs

DWORD Vector::BLF::FlexRayVFrReceiveMsgEx::frameLengthNs {}

length of frame in ns

Length of frame in ns (only valid for frames received in asynchronous mode, bit 15 is set in the frame flags)

◆ headerCrc1

WORD Vector::BLF::FlexRayVFrReceiveMsgEx::headerCrc1 {}

header crc channel 1

Header CRC FlexRay channel 1 (A)

◆ headerCrc2

WORD Vector::BLF::FlexRayVFrReceiveMsgEx::headerCrc2 {}

header crc channel 2

Header CRC FlexRay channel 2 (B)

◆ pduOffset

WORD Vector::BLF::FlexRayVFrReceiveMsgEx::pduOffset {}

payload offset (position in a frame)

For PDUs only: offset in bytes of PDU in an owner (raw) frame

◆ reservedFlexRayVFrReceiveMsgEx

std::array<WORD, 13> Vector::BLF::FlexRayVFrReceiveMsgEx::reservedFlexRayVFrReceiveMsgEx {}

reserved

◆ tag

DWORD Vector::BLF::FlexRayVFrReceiveMsgEx::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)

◆ version

WORD Vector::BLF::FlexRayVFrReceiveMsgEx::version {}

version of data struct

Object version, for internal use


The documentation for this struct was generated from the following files: