.TH "Vector::BLF::FlexRayVFrReceiveMsg" 3 "Vector BLF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
Vector::BLF::FlexRayVFrReceiveMsg \- FR_RCVMESSAGE\&.  

.SH SYNOPSIS
.br
.PP
.PP
\fR#include <FlexRayVFrReceiveMsg\&.h>\fP
.PP
Inherits \fBVector::BLF::ObjectHeader\fP\&.
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "void \fBread\fP (\fBAbstractFile\fP &is) override"
.br
.ti -1c
.RI "void \fBwrite\fP (\fBAbstractFile\fP &os) override"
.br
.ti -1c
.RI "uint32_t \fBcalculateObjectSize\fP () const override"
.br
.in -1c

Public Member Functions inherited from \fBVector::BLF::ObjectHeader\fP
.in +1c
.ti -1c
.RI "\fBObjectHeader\fP (const ObjectType \fBobjectType\fP, const uint16_t \fBobjectVersion\fP=0)"
.br
.ti -1c
.RI "void \fBread\fP (\fBAbstractFile\fP &is) override"
.br
.ti -1c
.RI "void \fBwrite\fP (\fBAbstractFile\fP &os) override"
.br
.ti -1c
.RI "uint16_t \fBcalculateHeaderSize\fP () const override"
.br
.ti -1c
.RI "uint32_t \fBcalculateObjectSize\fP () const override"
.br
.in -1c

Public Member Functions inherited from \fBVector::BLF::ObjectHeaderBase\fP
.in +1c
.ti -1c
.RI "\fBObjectHeaderBase\fP (const uint16_t \fBheaderVersion\fP, const ObjectType \fBobjectType\fP)"
.br
.ti -1c
.RI "\fBObjectHeaderBase\fP (const ObjectHeaderBase &)=default"
.br
.ti -1c
.RI "ObjectHeaderBase & \fBoperator=\fP (const ObjectHeaderBase &)=default"
.br
.ti -1c
.RI "\fBObjectHeaderBase\fP (ObjectHeaderBase &&)=default"
.br
.ti -1c
.RI "ObjectHeaderBase & \fBoperator=\fP (ObjectHeaderBase &&)=default"
.br
.in -1c
.SS "Public Attributes"

.in +1c
.ti -1c
.RI "uint16_t \fBchannel\fP {}"
.br
.RI "application channel "
.ti -1c
.RI "uint16_t \fBversion\fP {}"
.br
.RI "version of data struct "
.ti -1c
.RI "uint16_t \fBchannelMask\fP {}"
.br
.RI "channel mask "
.ti -1c
.RI "uint8_t \fBdir\fP {}"
.br
.RI "dir flag (tx, rx) "
.ti -1c
.RI "uint8_t \fBreservedFlexRayVFrReceiveMsg1\fP {}"
.br
.ti -1c
.RI "uint32_t \fBclientIndexFlexRayVFrReceiveMsg\fP {}"
.br
.RI "clientindex of send node "
.ti -1c
.RI "uint32_t \fBclusterNo\fP {}"
.br
.RI "number of cluster "
.ti -1c
.RI "uint16_t \fBframeId\fP {}"
.br
.RI "slot identifier, word "
.ti -1c
.RI "uint16_t \fBheaderCrc1\fP {}"
.br
.RI "header crc channel 1 "
.ti -1c
.RI "uint16_t \fBheaderCrc2\fP {}"
.br
.RI "header crc channel 2 "
.ti -1c
.RI "uint16_t \fBbyteCount\fP {}"
.br
.RI "byte count (not payload) of frame from CC receive buffer "
.ti -1c
.RI "uint16_t \fBdataCount\fP {}"
.br
.RI "length of the data array (stretchy struct) "
.ti -1c
.RI "uint8_t \fBcycle\fP {}"
.br
.RI "current cycle "
.ti -1c
.RI "uint8_t \fBreservedFlexRayVFrReceiveMsg2\fP {}"
.br
.ti -1c
.RI "uint32_t \fBtag\fP {}"
.br
.RI "type of cc "
.ti -1c
.RI "uint32_t \fBdata\fP {}"
.br
.RI "frame flags "
.ti -1c
.RI "uint32_t \fBframeFlags\fP {}"
.br
.RI "frame flags "
.ti -1c
.RI "uint32_t \fBappParameter\fP {}"
.br
.RI "TxRq, TxAck flags\&. "
.ti -1c
.RI "std::array< uint8_t, 254 > \fBdataBytes\fP {}"
.br
.RI "array of databytes "
.ti -1c
.RI "uint16_t \fBreservedFlexRayVFrReceiveMsg3\fP {}"
.br
.ti -1c
.RI "uint32_t \fBreservedFlexRayVFrReceiveMsg4\fP {}"
.br
.in -1c

Public Attributes inherited from \fBVector::BLF::ObjectHeader\fP
.in +1c
.ti -1c
.RI "uint32_t \fBobjectFlags\fP {\fBObjectFlags::TimeOneNans\fP}"
.br
.RI "object flags "
.ti -1c
.RI "uint16_t \fBclientIndex\fP {}"
.br
.RI "client index of send node "
.ti -1c
.RI "uint16_t \fBobjectVersion\fP {0}"
.br
.RI "object specific version "
.ti -1c
.RI "uint64_t \fBobjectTimeStamp\fP {}"
.br
.RI "object timestamp "
.in -1c

Public Attributes inherited from \fBVector::BLF::ObjectHeaderBase\fP
.in +1c
.ti -1c
.RI "uint32_t \fBsignature\fP {ObjectSignature}"
.br
.RI "signature (ObjectSignature) "
.ti -1c
.RI "uint16_t \fBheaderSize\fP {}"
.br
.RI "sizeof object header "
.ti -1c
.RI "uint16_t \fBheaderVersion\fP {}"
.br
.RI "header version (1) "
.ti -1c
.RI "uint32_t \fBobjectSize\fP {}"
.br
.RI "object size "
.ti -1c
.RI "ObjectType \fBobjectType\fP {ObjectType::UNKNOWN}"
.br
.RI "object type "
.in -1c
.SS "Additional Inherited Members"


Public Types inherited from \fBVector::BLF::ObjectHeader\fP
.in +1c
.ti -1c
.RI "enum \fBObjectFlags\fP : uint32_t { \fBTimeTenMics\fP = 0x00000001, \fBTimeOneNans\fP = 0x00000002 }"
.br
.in -1c
.SH "Detailed Description"
.PP 
FR_RCVMESSAGE\&. 

FlexRay message received or transmitted on FlexRay bus\&. 
.SH "Member Function Documentation"
.PP 
.SS "uint32_t Vector::BLF::FlexRayVFrReceiveMsg::calculateObjectSize () const\fR [override]\fP, \fR [virtual]\fP"
Calculates the objectSize

.PP
\fBReturns\fP
.RS 4
object size 
.RE
.PP

.PP
Reimplemented from \fBVector::BLF::ObjectHeaderBase\fP\&.
.SS "void Vector::BLF::FlexRayVFrReceiveMsg::read (\fBAbstractFile\fP & is)\fR [override]\fP, \fR [virtual]\fP"
Read the data of this object

.PP
\fBParameters\fP
.RS 4
\fIis\fP input stream 
.RE
.PP

.PP
Reimplemented from \fBVector::BLF::ObjectHeaderBase\fP\&.
.SS "void Vector::BLF::FlexRayVFrReceiveMsg::write (\fBAbstractFile\fP & os)\fR [override]\fP, \fR [virtual]\fP"
Write the data of this object

.PP
\fBParameters\fP
.RS 4
\fIos\fP output stream 
.RE
.PP

.PP
Reimplemented from \fBVector::BLF::ObjectHeaderBase\fP\&.
.SH "Member Data Documentation"
.PP 
.SS "uint32_t Vector::BLF::FlexRayVFrReceiveMsg::appParameter {}"

.PP
TxRq, TxAck flags\&. Not used, reserved 
.SS "uint16_t Vector::BLF::FlexRayVFrReceiveMsg::byteCount {}"

.PP
byte count (not payload) of frame from CC receive buffer Payload length in bytes 
.SS "uint16_t Vector::BLF::FlexRayVFrReceiveMsg::channel {}"

.PP
application channel Application channel 
.SS "uint16_t Vector::BLF::FlexRayVFrReceiveMsg::channelMask {}"

.PP
channel mask Channel Mask
.IP "\(bu" 2
0 = Reserved or invalid
.IP "\(bu" 2
1 = FlexRay Channel A
.IP "\(bu" 2
2 = FlexRay Channel B
.IP "\(bu" 2
3 = FlexRay Channels A and B 
.PP

.SS "uint32_t Vector::BLF::FlexRayVFrReceiveMsg::clientIndexFlexRayVFrReceiveMsg {}"

.PP
clientindex of send node Client index of send node\&. Must be set to 0 if file is written from other applications\&. 
.SS "uint32_t Vector::BLF::FlexRayVFrReceiveMsg::clusterNo {}"

.PP
number of cluster Number of cluster: channel number - 1 
.SS "uint8_t Vector::BLF::FlexRayVFrReceiveMsg::cycle {}"

.PP
current cycle Cycle number 
.SS "uint32_t Vector::BLF::FlexRayVFrReceiveMsg::data {}"

.PP
frame flags Description of frame flags:
.IP "\(bu" 2
Bit 0: 1 = Null frame\&.
.IP "\(bu" 2
Bit 1: 1 = Data segment contains valid data
.IP "\(bu" 2
Bit 2: 1 = Sync bit
.IP "\(bu" 2
Bit 3: 1 = Startup flag
.IP "\(bu" 2
Bit 4: 1 = Payload preamble bit
.IP "\(bu" 2
Bit 5: 1 = Reserved bit
.IP "\(bu" 2
Bit 6: 1 = Error flag (error frame or invalid frame)
.IP "\(bu" 2
Bit 7: Reserved
.IP "\(bu" 2
Bit 8: Internally used in CANoe/CANalyzer
.IP "\(bu" 2
Bit 9: Internally used in CANoe/CANalyzer
.IP "\(bu" 2
Bit 10: Internally used in CANoe/CANalyzer
.IP "\(bu" 2
Bit 11: Internally used in CANoe/CANalyzer
.IP "\(bu" 2
Bit 12: Internally used in CANoe/CANalyzer
.IP "\(bu" 2
Bit 13: Internally used in CANoe/CANalyzer
.IP "\(bu" 2
Bit 14: Internally used in CANoe/CANalyzer
.IP "\(bu" 2
Bit 15: 1 = Async\&. monitoring has generated this event
.IP "\(bu" 2
Bit 16: 1 = Event is a PDU
.IP "\(bu" 2
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)\&.
.IP "\(bu" 2
Bit 18: Reserved
.IP "\(bu" 2
Bit 19: 1 = Raw frame (only valid if PDUs are used in the configuration)\&. A raw frame may contain PDUs in its payload
.IP "\(bu" 2
Bit 20: 1 = Dynamic segment 0 = Static segment
.IP "\(bu" 2
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\&.
.IP "\(bu" 2
Bit 22 Valid for PDUs only\&. The bit is set if the PDU has an update bit
.PP

.PP
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\&. 
.SS "std::array<uint8_t, 254> Vector::BLF::FlexRayVFrReceiveMsg::dataBytes {}"

.PP
array of databytes Payload 
.SS "uint16_t Vector::BLF::FlexRayVFrReceiveMsg::dataCount {}"

.PP
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\&. 
.SS "uint8_t Vector::BLF::FlexRayVFrReceiveMsg::dir {}"

.PP
dir flag (tx, rx) Direction Flags
.IP "\(bu" 2
0 = Rx
.IP "\(bu" 2
1 = Tx
.IP "\(bu" 2
2 = Tx Request
.IP "\(bu" 2
3 and 4 are for internal use only\&. 
.PP

.SS "uint32_t Vector::BLF::FlexRayVFrReceiveMsg::frameFlags {}"

.PP
frame flags Description of frame flags:
.IP "\(bu" 2
Bit 0: 1 = Null frame\&.
.IP "\(bu" 2
Bit 1: 1 = Data segment contains valid data
.IP "\(bu" 2
Bit 2: 1 = Sync bit
.IP "\(bu" 2
Bit 3: 1 = Startup flag
.IP "\(bu" 2
Bit 4: 1 = Payload preamble bit
.IP "\(bu" 2
Bit 5: 1 = Reserved bit
.IP "\(bu" 2
Bit 6: 1 = Error flag (error frame or invalid frame)
.IP "\(bu" 2
Bit 7: Reserved
.IP "\(bu" 2
Bit 8: Internally used in CANoe/CANalyzer
.IP "\(bu" 2
Bit 9: Internally used in CANoe/CANalyzer
.IP "\(bu" 2
Bit 10: Internally used in CANoe/CANalyzer
.IP "\(bu" 2
Bit 11: Internally used in CANoe/CANalyzer
.IP "\(bu" 2
Bit 12: Internally used in CANoe/CANalyzer
.IP "\(bu" 2
Bit 13: Internally used in CANoe/CANalyzer
.IP "\(bu" 2
Bit 14: Internally used in CANoe/CANalyzer
.IP "\(bu" 2
Bit 15: 1 = Async\&. monitoring has generated this event
.IP "\(bu" 2
Bit 16: 1 = Event is a PDU
.IP "\(bu" 2
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)\&.
.IP "\(bu" 2
Bit 18: Reserved
.IP "\(bu" 2
Bit 19: 1 = Raw frame (only valid if PDUs are used in the configuration)\&. A raw frame may contain PDUs in its payload
.IP "\(bu" 2
Bit 20: 1 = Dynamic segment 0 = Static segment
.IP "\(bu" 2
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\&.
.IP "\(bu" 2
Bit 22 Valid for PDUs only\&. The bit is set if the PDU has an update bit
.PP

.PP
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\&. 
.SS "uint16_t Vector::BLF::FlexRayVFrReceiveMsg::frameId {}"

.PP
slot identifier, word Slot identifier 
.SS "uint16_t Vector::BLF::FlexRayVFrReceiveMsg::headerCrc1 {}"

.PP
header crc channel 1 Header CRC FlexRay channel 1 (A) 
.SS "uint16_t Vector::BLF::FlexRayVFrReceiveMsg::headerCrc2 {}"

.PP
header crc channel 2 Header CRC FlexRay channel 2 (B) 
.SS "uint8_t Vector::BLF::FlexRayVFrReceiveMsg::reservedFlexRayVFrReceiveMsg1 {}"
reserved 
.SS "uint8_t Vector::BLF::FlexRayVFrReceiveMsg::reservedFlexRayVFrReceiveMsg2 {}"
reserved 
.SS "uint16_t Vector::BLF::FlexRayVFrReceiveMsg::reservedFlexRayVFrReceiveMsg3 {}"
reserved 
.SS "uint32_t Vector::BLF::FlexRayVFrReceiveMsg::reservedFlexRayVFrReceiveMsg4 {}"
reserved 
.SS "uint32_t Vector::BLF::FlexRayVFrReceiveMsg::tag {}"

.PP
type of cc Type of communication controller
.IP "\(bu" 2
0 = Architecture independent
.IP "\(bu" 2
1 = Invalid CC type (for internal use only)
.IP "\(bu" 2
2 = Cyclone I
.IP "\(bu" 2
3 = BUSDOCTOR
.IP "\(bu" 2
4 = Cyclone II
.IP "\(bu" 2
5 = Vector VN interface
.IP "\(bu" 2
6 = VN-Sync-Pulse (only in Status Event, for debugging purposes only) 
.PP

.SS "uint16_t Vector::BLF::FlexRayVFrReceiveMsg::version {}"

.PP
version of data struct Object version, for internal use 

.SH "Author"
.PP 
Generated automatically by Doxygen for Vector BLF from the source code\&.