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

.SH SYNOPSIS
.br
.PP
.PP
\fR#include <LinReceiveError\&.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 "uint8_t \fBid\fP {}"
.br
.RI "LIN ID\&. "
.ti -1c
.RI "uint8_t \fBdlc\fP {}"
.br
.RI "LIN DLC\&. "
.ti -1c
.RI "uint8_t \fBfsmId\fP {}"
.br
.ti -1c
.RI "uint8_t \fBfsmState\fP {}"
.br
.ti -1c
.RI "uint8_t \fBheaderTime\fP {}"
.br
.ti -1c
.RI "uint8_t \fBfullTime\fP {}"
.br
.ti -1c
.RI "uint8_t \fBstateReason\fP {}"
.br
.ti -1c
.RI "uint8_t \fBoffendingByte\fP {}"
.br
.ti -1c
.RI "uint8_t \fBshortError\fP {}"
.br
.ti -1c
.RI "uint8_t \fBtimeoutDuringDlcDetection\fP {}"
.br
.ti -1c
.RI "uint32_t \fBreservedLinReceiveError\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 
LIN_RCV_ERROR\&. 


.PP
\fBDeprecated\fP
.RS 4

.RE
.PP

.PP
This event may have a wide variety of causes\&.

.PP
An external Master can cause a receive error event:
.IP "\(bu" 2
by transmitting sync break that is too short,
.IP "\(bu" 2
by not returning the correct value 0x55 in the sync field,
.IP "\(bu" 2
by assigning an incorrect parity to the frame identifier\&. Other reasons:
.IP "\(bu" 2
Slave transmitting an illegal character during a Bus Idle phase (e\&.g\&. because it did not finish transmission quickly enough and the checksum byte of the response was sent during the Bus Idle phase),
.IP "\(bu" 2
Faulty (dominant) stop bit (i\&.e\&. framing error),
.IP "\(bu" 2
LIN hardware receives a character that is different from the character sent during transmission
.IP "\(bu" 2
LIN hardware only receives part of a frame, at the start of a measurement (in a correctly functioning system)\&. 
.PP

.SH "Member Function Documentation"
.PP 
.SS "uint32_t Vector::BLF::LinReceiveError::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::LinReceiveError::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::LinReceiveError::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 "uint16_t Vector::BLF::LinReceiveError::channel {}"

.PP
application channel Channel number where the event notified 
.SS "uint8_t Vector::BLF::LinReceiveError::dlc {}"

.PP
LIN DLC\&. Frame length 
.SS "uint8_t Vector::BLF::LinReceiveError::fsmId {}"
Slave Identifier in the Final State Machine (obsolete) 
.SS "uint8_t Vector::BLF::LinReceiveError::fsmState {}"
State Identifier of a Slave in the Final State Machine (obsolete) 
.SS "uint8_t Vector::BLF::LinReceiveError::fullTime {}"
Duration of the entire frame [in bit times] 
.SS "uint8_t Vector::BLF::LinReceiveError::headerTime {}"
Duration of the frame header [in bit times] 
.SS "uint8_t Vector::BLF::LinReceiveError::id {}"

.PP
LIN ID\&. Frame identifier 
.SS "uint8_t Vector::BLF::LinReceiveError::offendingByte {}"
Byte value that resulted the protocol violation\&. Only valid for certain values of stateReason 
.SS "uint32_t Vector::BLF::LinReceiveError::reservedLinReceiveError {}"
reserved 
.SS "uint8_t Vector::BLF::LinReceiveError::shortError {}"
Specifies the detail level of the event\&. Following values are possible:
.IP "\(bu" 2
0: short
.IP "\(bu" 2
1: full Most members are not valid unless this member is 1 
.PP

.SS "uint8_t Vector::BLF::LinReceiveError::stateReason {}"
The lower 4 bits indicate the LIN hardware state at the time the error has occurred, while the upper 4 bits indicate the reason of the error

.PP
Value for the state:
.IP "\(bu" 2
0: Bus idle
.IP "\(bu" 2
1: Waiting for SynchBreak
.IP "\(bu" 2
2: Waiting for SynchField
.IP "\(bu" 2
3: Waiting for frame ID
.IP "\(bu" 2
4-12: Waiting for data byte or checksum byte depending on the frame length\&. E\&.g\&. value 4 for FrameLength=0, value 12 for FrameLength=8
.IP "\(bu" 2
15: Not expected event (i\&.e\&. not WakeupRequest) during sleep mode\&. Occurs for LIN hardware in Master mode only
.PP

.PP
Values for the reason:
.IP "\(bu" 2
0: Timeout
.IP "\(bu" 2
1: Received an unexpected byte violating protocol\&. In this case, offendingByte member contains its value
.IP "\(bu" 2
2: Received a byte with framing error (with dominant stop bit)\&. In this case, offendingByte member contains its value
.IP "\(bu" 2
3: Unexpected Break field
.IP "\(bu" 2
4: Unidentified error 
.PP

.SS "uint8_t Vector::BLF::LinReceiveError::timeoutDuringDlcDetection {}"
Flag indicating if the error is a result of an attempt to resolve frame length\&. Following values are possible:
.IP "\(bu" 2
0: False
.IP "\(bu" 2
1: True 
.PP


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