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

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

.in +1c
.ti -1c
.RI "\fBvoid\fP \fBread\fP (\fBAbstractFile\fP &\fBis\fP) \fBoverride\fP"
.br
.ti -1c
.RI "\fBvoid\fP \fBwrite\fP (\fBAbstractFile\fP &\fBos\fP) \fBoverride\fP"
.br
.ti -1c
.RI "\fBuint32_t\fP \fBcalculateObjectSize\fP () \fBconst\fP \fBoverride\fP"
.br
.in -1c

Public Member Functions inherited from \fBVector::BLF::ObjectHeader\fP
.in +1c
.ti -1c
.RI "\fBObjectHeader\fP (\fBconst\fP ObjectType \fBobjectType\fP, \fBconst\fP \fBuint16_t\fP \fBobjectVersion\fP=0)"
.br
.ti -1c
.RI "\fBvoid\fP \fBread\fP (\fBAbstractFile\fP &\fBis\fP) \fBoverride\fP"
.br
.ti -1c
.RI "\fBvoid\fP \fBwrite\fP (\fBAbstractFile\fP &\fBos\fP) \fBoverride\fP"
.br
.ti -1c
.RI "\fBuint16_t\fP \fBcalculateHeaderSize\fP () \fBconst\fP \fBoverride\fP"
.br
.ti -1c
.RI "\fBuint32_t\fP \fBcalculateObjectSize\fP () \fBconst\fP \fBoverride\fP"
.br
.in -1c

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

.in +1c
.ti -1c
.RI "\fBuint16_t\fP \fBchannel\fP {}"
.br
.RI "application channel "
.ti -1c
.RI "\fBuint16_t\fP \fBversion\fP {}"
.br
.RI "object version "
.ti -1c
.RI "\fBuint16_t\fP \fBchannelMask\fP {}"
.br
.RI "channel mask "
.ti -1c
.RI "\fBuint8_t\fP \fBcycle\fP {}"
.br
.RI "current cycle "
.ti -1c
.RI "\fBuint8_t\fP \fBreservedFlexRayVFrError1\fP {}"
.br
.ti -1c
.RI "\fBuint32_t\fP \fBclientIndexFlexRayVFrError\fP {}"
.br
.RI "clientindex of send node "
.ti -1c
.RI "\fBuint32_t\fP \fBclusterNo\fP {}"
.br
.RI "number of cluster "
.ti -1c
.RI "\fBuint32_t\fP \fBtag\fP {}"
.br
.RI "type of cc "
.ti -1c
.RI "std::array< \fBuint32_t\fP, 4 > \fBdata\fP {}"
.br
.RI "register flags "
.ti -1c
.RI "\fBuint32_t\fP \fBreservedFlexRayVFrError2\fP {}"
.br
.in -1c

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

Public Attributes inherited from \fBVector::BLF::ObjectHeaderBase\fP
.in +1c
.ti -1c
.RI "\fBuint32_t\fP \fBsignature\fP {ObjectSignature}"
.br
.RI "signature (ObjectSignature) "
.ti -1c
.RI "\fBuint16_t\fP \fBheaderSize\fP {}"
.br
.RI "sizeof object header "
.ti -1c
.RI "\fBuint16_t\fP \fBheaderVersion\fP {}"
.br
.RI "header version (1) "
.ti -1c
.RI "\fBuint32_t\fP \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_ERROR\&. 

FlexRay Error event transmitted by the FlexRay hardware\&. 
.SH "Member Function Documentation"
.PP 
.SS "\fBuint32_t\fP Vector::BLF::FlexRayVFrError::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 "\fBvoid\fP Vector::BLF::FlexRayVFrError::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 "\fBvoid\fP Vector::BLF::FlexRayVFrError::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 "\fBuint16_t\fP Vector::BLF::FlexRayVFrError::channel {}"

.PP
application channel Application channel 
.SS "\fBuint16_t\fP Vector::BLF::FlexRayVFrError::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 "\fBuint32_t\fP Vector::BLF::FlexRayVFrError::clientIndexFlexRayVFrError {}"

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

.PP
number of cluster Number of cluster: channel number - 1 
.SS "\fBuint8_t\fP Vector::BLF::FlexRayVFrError::cycle {}"

.PP
current cycle Cycle number 
.SS "std::array<\fBuint32_t\fP, 4> Vector::BLF::FlexRayVFrError::data {}"

.PP
register flags Driver flags for internal usage
.PP
CC-Type: Cyclone I
.IP "\(bu" 2
data[0]: Error flags from driver API
.PP
.PP
CC-Type: Cyclone II
.IP "\(bu" 2
data[0]: Error packet flag:
.IP "  \(bu" 4
0 = No error
.IP "  \(bu" 4
1 = FlexCard overflow
.IP "  \(bu" 4
2 = PCO error mode changed
.IP "  \(bu" 4
3 = Sync frames below minimum
.IP "  \(bu" 4
4 = Sync frame overflow
.IP "  \(bu" 4
5 = Clock correction failure
.IP "  \(bu" 4
6 = Parity error
.IP "  \(bu" 4
7 = Receive FIFO overrun
.IP "  \(bu" 4
8 = Empty FIFO access
.IP "  \(bu" 4
9 = Illegal input buffer access
.IP "  \(bu" 4
10 = Illegal output buffer access
.IP "  \(bu" 4
11 = Syntax error
.IP "  \(bu" 4
12 = Content error
.IP "  \(bu" 4
13 = Slot boundary violation
.IP "  \(bu" 4
14 = Transmission across boundary
.IP "  \(bu" 4
15 = Latest transmit violation
.PP

.IP "\(bu" 2
data[1]: uint32_t layout depends on the error packet value (see previous row)
.IP "  \(bu" 4
Error packet=2:
.IP "    \(bu" 6
0 = Unknown state
.IP "    \(bu" 6
1 = FlexRay protocol spec\&. > CONFIG
.IP "    \(bu" 6
2 = FlexRay protocol spec\&. > NORMAL_ACTIVE
.IP "    \(bu" 6
3 = FlexRay protocol spec\&. > NORMAL_PASSIVE
.IP "    \(bu" 6
4 = FlexRay protocol spec\&. > HALT
.IP "    \(bu" 6
5 = FlexRay protocol spec\&. > READY
.IP "    \(bu" 6
6 = FlexRay protocol spec\&. > STARTUP
.IP "    \(bu" 6
7 = FlexRay protocol spec\&. > WAKEUP
.PP

.IP "  \(bu" 4
Error packet = 3 or 4:
.IP "    \(bu" 6
Bits 0\&.\&.3 > Sync frames even on channel A
.IP "    \(bu" 6
Bits 4\&.\&.7 > Sync frames even on channel B
.IP "    \(bu" 6
Bits 8\&.\&.11 > Sync frames odd on channel A
.IP "    \(bu" 6
Bits 12\&.\&.15 > Sync frames odd on channel B
.PP

.IP "  \(bu" 4
Error packet = 5:
.IP "    \(bu" 6
Bit 0 > Missing rate correction
.IP "    \(bu" 6
Bit 1 > Rate correction limit reached
.IP "    \(bu" 6
Bit 2 > Offset correction limit reached
.IP "    \(bu" 6
Bit 3 > Missing offset correction
.IP "    \(bu" 6
Bit 4\&.\&.7 > Sync frames even on channel A
.IP "    \(bu" 6
Bits 8\&.\&.11 > Sync frames even on channel B
.IP "    \(bu" 6
Bits 12\&.\&.15 > Sync frames odd on channel A
.IP "    \(bu" 6
Bits 16\&.\&.19 > Sync frames odd on channel B
.PP

.IP "  \(bu" 4
Error packet = 11\&.\&.15:
.IP "    \(bu" 6
LOW-WORD of mData[1] > Channel
.IP "    \(bu" 6
HI-WORD of mData[1] > Slot count
.PP

.PP

.PP
.PP
CC-Type: BUSDOCTOR
.IP "\(bu" 2
data[0]: Error flags from driver API
.PP
.PP
CC-Type: VN-Interface
.IP "\(bu" 2
data[0]: Error tag:
.IP "  \(bu" 4
0 = FR_ERROR_POC_MODE
.IP "  \(bu" 4
1 = FR_ERROR_SYNC_FRAMES_BELOWMIN
.IP "  \(bu" 4
2 = FR_ERROR_SYNC_FRAMES_OVERLOAD
.IP "  \(bu" 4
3 = FR_ERROR_CLOCK_CORR_FAILURE
.IP "  \(bu" 4
4 = FR_ERROR_NIT_FAILURE
.IP "  \(bu" 4
5 = FR_ERROR_CC_ERROR
.IP "  \(bu" 4
6 = FR_ERROR_OVERFLOW
.PP

.IP "\(bu" 2
data[1] and data[2]: uint32_t layout depends on the error tag value (see previous row):
.IP "  \(bu" 4
Error tag = 0:
.IP "    \(bu" 6
Value 0: FR_ERROR_POC_ACTIVE
.IP "    \(bu" 6
Value 1: FR_ERROR_POC_PASSIVE
.IP "    \(bu" 6
Value 2: FR_ERROR_POC_COMM_HALT
.PP

.IP "  \(bu" 4
Error tag = 1 or 2:
.IP "    \(bu" 6
Bits 0\&.\&.3: Sync frames even on channel A
.IP "    \(bu" 6
Bits 4\&.\&.7: Sync frames even on channel B
.IP "    \(bu" 6
Bits 8\&.\&.11: Sync frames odd on channel A
.IP "    \(bu" 6
Bits 12\&.\&.15: Sync frames odd on channel B
.PP

.IP "  \(bu" 4
Error tag = 3:
.IP "    \(bu" 6
Bit 0: Missing rate correction
.IP "    \(bu" 6
Bit 1: Missing rate correction limit reached
.IP "    \(bu" 6
Bit 2: Offset correction limit reached
.IP "    \(bu" 6
Bit 3: Missing offset correction
.IP "    \(bu" 6
Bits 4\&.\&.19: Clock correction failed counter
.IP "    \(bu" 6
Bits 20\&.\&.23: Sync frames even on channel A
.IP "    \(bu" 6
Bits 24\&.\&.27: Sync frames even on channel B
.IP "    \(bu" 6
Bits 28\&.\&.31: Sync frames odd on channel A
.IP "    \(bu" 6
Bits 32\&.\&.35: Sync frames odd on channel B
.PP

.IP "  \(bu" 4
Error tag = 4:
.IP "    \(bu" 6
Value 1: FR_ERROR_NIT_SENA
.IP "    \(bu" 6
Value 2: FR_ERROR_NIT_SBNA
.IP "    \(bu" 6
Value 4: FR_ERROR_NIT_SENB
.IP "    \(bu" 6
Value 8: FR_ERROR_NIT_SBNB
.PP

.IP "  \(bu" 4
Error tag = 5:
.IP "    \(bu" 6
Value 0x00000001: POC Error Mode Changed
.IP "    \(bu" 6
Value 0x00000004: Sync Frames Below Minimum
.IP "    \(bu" 6
Value 0x00000008: Sync Frame Overflow
.IP "    \(bu" 6
Value 0x00000010: Clock Correction Failure
.IP "    \(bu" 6
Value 0x00000040: Parity Error, data from MHDS (internal ERay error)
.IP "    \(bu" 6
Value 0x00000200: Illegal Input Buffer Access (internal ERay error)
.IP "    \(bu" 6
Value 0x00000400: Illegal Output Buffer Access (internal ERay error)
.IP "    \(bu" 6
Value 0x00000800: Message Handler Constraints Flag data from MHDF (internal ERay error)
.IP "    \(bu" 6
Value 0x00010000: Error Detection on channel A, data from ACS
.IP "    \(bu" 6
Value 0x00020000: Latest Transmit Violation on channel A
.IP "    \(bu" 6
Value 0x00040000: Transmit Across Boundary on Channel A
.IP "    \(bu" 6
Value 0x01000000: Error Detection on channel B, data from ACS
.IP "    \(bu" 6
Value 0x02000000: Latest Transmit Violation on channel B
.IP "    \(bu" 6
Value 0x04000000: Transmit Across Boundary on Channel B 
.PP

.PP

.PP

.SS "\fBuint8_t\fP Vector::BLF::FlexRayVFrError::reservedFlexRayVFrError1 {}"
reserved 
.SS "\fBuint32_t\fP Vector::BLF::FlexRayVFrError::reservedFlexRayVFrError2 {}"
reserved 
.SS "\fBuint32_t\fP Vector::BLF::FlexRayVFrError::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 "\fBuint16_t\fP Vector::BLF::FlexRayVFrError::version {}"

.PP
object version Object version, for internal use 

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