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

.SH SYNOPSIS
.br
.PP
.PP
\fR#include <CanErrorFrameExt\&.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 \fBlength\fP {}"
.br
.RI "CAN error frame length\&. "
.ti -1c
.RI "uint32_t \fBflags\fP {}"
.br
.RI "extended CAN error frame flags "
.ti -1c
.RI "uint8_t \fBecc\fP {}"
.br
.RI "error control code "
.ti -1c
.RI "uint8_t \fBposition\fP {}"
.br
.RI "error position "
.ti -1c
.RI "uint8_t \fBdlc\fP {}"
.br
.RI "lower 4 bits: DLC from CAN-Core\&. Upper 4 bits: reserved "
.ti -1c
.RI "uint8_t \fBreservedCanErrorFrameExt1\fP {}"
.br
.ti -1c
.RI "uint32_t \fBframeLengthInNs\fP {}"
.br
.RI "frame length in ns "
.ti -1c
.RI "uint32_t \fBid\fP {}"
.br
.RI "frame ID from CAN-Core "
.ti -1c
.RI "uint16_t \fBflagsExt\fP {}"
.br
.RI "extended error flags "
.ti -1c
.RI "uint16_t \fBreservedCanErrorFrameExt2\fP {}"
.br
.ti -1c
.RI "std::vector< uint8_t > \fBdata\fP {}"
.br
.RI "Payload, only for CAN-Core\&. "
.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 
CAN_ERROR_EXT\&. 

Extended CAN error frame received or transmitted on a CAN channel\&. 
.SH "Member Function Documentation"
.PP 
.SS "uint32_t Vector::BLF::CanErrorFrameExt::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::CanErrorFrameExt::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::CanErrorFrameExt::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::CanErrorFrameExt::channel {}"

.PP
application channel Channel the frame was sent or received\&. 
.SS "std::vector<uint8_t> Vector::BLF::CanErrorFrameExt::data {}"

.PP
Payload, only for CAN-Core\&. Message data\&. 
.SS "uint8_t Vector::BLF::CanErrorFrameExt::dlc {}"

.PP
lower 4 bits: DLC from CAN-Core\&. Upper 4 bits: reserved Data length code of the corrupted message\&. 
.SS "uint8_t Vector::BLF::CanErrorFrameExt::ecc {}"

.PP
error control code Content of Philips SJA1000 Error Code Capture (ECC) register, or the Vector CAN-Core error register (see also flags)\&.

.PP
SJA1000-ECC

.PP
See documentation of Philips SJA1000 CAN Controller\&.

.PP
Vector CAN-Core

.PP
.IP "\(bu" 2
Bit 0-5 Meaning:
.IP "  \(bu" 4
0: Bit Error
.IP "  \(bu" 4
1: Form Error
.IP "  \(bu" 4
2: Stuff Error
.IP "  \(bu" 4
3: Other Error
.IP "  \(bu" 4
4: CRC Error
.IP "  \(bu" 4
5: Ack-Del-Error
.PP

.IP "\(bu" 2
Bit 6-7 Meaning:
.IP "  \(bu" 4
0: RX-NAK-Error
.IP "  \(bu" 4
1: TK-NAK-Error
.IP "  \(bu" 4
2: RX-Error
.IP "  \(bu" 4
3: TX-Error 
.PP

.PP

.SS "uint32_t Vector::BLF::CanErrorFrameExt::flags {}"

.PP
extended CAN error frame flags Defines what additional information is valid\&. Following values are possible:

.PP
.IP "\(bu" 2
1: SJA 1000 ECC is valid (member ecc)
.IP "\(bu" 2
2: Vector CAN Core Error Code is valid\&.
.IP "\(bu" 2
4: Vector CAN Core Error Position
.IP "\(bu" 2
8: Vector CAN Core Frame Length in ns 
.PP

.SS "uint16_t Vector::BLF::CanErrorFrameExt::flagsExt {}"

.PP
extended error flags Extended error flags\&.

.PP
.IP "\(bu" 2
Bit 0-4: Segment (only SJA1000)
.IP "\(bu" 2
Bit 5: Direction, 1=RX
.IP "\(bu" 2
Bit 6-11: Error Code
.IP "  \(bu" 4
0: Bit Error
.IP "  \(bu" 4
1: Form Error
.IP "  \(bu" 4
2: Stuff Error
.IP "  \(bu" 4
3: Other Error
.IP "  \(bu" 4
4: CRC Error
.IP "  \(bu" 4
5: ACK-DEL Error
.PP

.IP "\(bu" 2
Bit 12-13: Extended Direction
.IP "  \(bu" 4
0: RX NAK
.IP "  \(bu" 4
1: TX NAK
.IP "  \(bu" 4
2: RX
.IP "  \(bu" 4
3: TX
.PP

.IP "\(bu" 2
Bit 14: 1=The error frame was send from the application 
.PP

.SS "uint32_t Vector::BLF::CanErrorFrameExt::frameLengthInNs {}"

.PP
frame length in ns Length of the error frame in nanoseconds (time difference between Start Of Frame and End Of Frame) 
.SS "uint32_t Vector::BLF::CanErrorFrameExt::id {}"

.PP
frame ID from CAN-Core Message ID of the corrupted message\&. 
.SS "uint16_t Vector::BLF::CanErrorFrameExt::length {}"

.PP
CAN error frame length\&. Length of error frame, unused, may be 0\&. 
.SS "uint8_t Vector::BLF::CanErrorFrameExt::position {}"

.PP
error position Bit position of the error frame in the corrupted message\&. 
.SS "uint8_t Vector::BLF::CanErrorFrameExt::reservedCanErrorFrameExt1 {}"
reserved 
.SS "uint16_t Vector::BLF::CanErrorFrameExt::reservedCanErrorFrameExt2 {}"
reserved 

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