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

.SH SYNOPSIS
.br
.PP
.PP
\fR#include <CanFdErrorFrame64\&.h>\fP
.PP
Inherits \fBVector::BLF::ObjectHeader\fP, and \fBVector::BLF::CanFdExtFrameData\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
.ti -1c
.RI "\fBvirtual\fP \fBbool\fP \fBhasExtData\fP () \fBconst\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

Public Member Functions inherited from \fBVector::BLF::CanFdExtFrameData\fP
.in +1c
.ti -1c
.RI "\fBCanFdExtFrameData\fP (\fBconst\fP \fBCanFdExtFrameData\fP &)=\fBdefault\fP"
.br
.ti -1c
.RI "\fBCanFdExtFrameData\fP & \fBoperator=\fP (\fBconst\fP \fBCanFdExtFrameData\fP &)=\fBdefault\fP"
.br
.ti -1c
.RI "\fBCanFdExtFrameData\fP (\fBCanFdExtFrameData\fP &&)=\fBdefault\fP"
.br
.ti -1c
.RI "\fBCanFdExtFrameData\fP & \fBoperator=\fP (\fBCanFdExtFrameData\fP &&)=\fBdefault\fP"
.br
.in -1c
.SS "Public Attributes"

.in +1c
.ti -1c
.RI "\fBuint8_t\fP \fBchannel\fP {}"
.br
.RI "application channel "
.ti -1c
.RI "\fBuint8_t\fP \fBdlc\fP {}"
.br
.RI "CAN dlc\&. "
.ti -1c
.RI "\fBuint8_t\fP \fBvalidDataBytes\fP {}"
.br
.RI "Valid payload length of data\&. "
.ti -1c
.RI "\fBuint8_t\fP \fBecc\fP {}"
.br
.ti -1c
.RI "\fBuint16_t\fP \fBflags\fP {}"
.br
.ti -1c
.RI "\fBuint16_t\fP \fBerrorCodeExt\fP {}"
.br
.ti -1c
.RI "\fBuint16_t\fP \fBextFlags\fP {}"
.br
.RI "FD specific flags\&. "
.ti -1c
.RI "\fBuint8_t\fP \fBextDataOffset\fP {}"
.br
.ti -1c
.RI "\fBuint8_t\fP \fBreservedCanFdErrorFrame1\fP {}"
.br
.ti -1c
.RI "\fBuint32_t\fP \fBid\fP {}"
.br
.RI "CAN ID\&. "
.ti -1c
.RI "\fBuint32_t\fP \fBframeLength\fP {}"
.br
.RI "message length in ns "
.ti -1c
.RI "\fBuint32_t\fP \fBbtrCfgArb\fP {}"
.br
.RI "bit rate used in arbitration phase "
.ti -1c
.RI "\fBuint32_t\fP \fBbtrCfgData\fP {}"
.br
.RI "bit rate used in data phase "
.ti -1c
.RI "\fBuint32_t\fP \fBtimeOffsetBrsNs\fP {}"
.br
.RI "time offset of brs field "
.ti -1c
.RI "\fBuint32_t\fP \fBtimeOffsetCrcDelNs\fP {}"
.br
.RI "time offset of brs field "
.ti -1c
.RI "\fBuint32_t\fP \fBcrc\fP {}"
.br
.ti -1c
.RI "\fBuint16_t\fP \fBerrorPosition\fP {}"
.br
.RI "error position as bit offset "
.ti -1c
.RI "\fBuint16_t\fP \fBreservedCanFdErrorFrame2\fP {}"
.br
.ti -1c
.RI "std::vector< \fBuint8_t\fP > \fBdata\fP {}"
.br
.RI "CAN FD data\&. "
.ti -1c
.RI "std::vector< \fBuint8_t\fP > \fBreservedCanFdErrorFrame64\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

Public Attributes inherited from \fBVector::BLF::CanFdExtFrameData\fP
.in +1c
.ti -1c
.RI "\fBuint32_t\fP \fBbtrExtArb\fP {}"
.br
.ti -1c
.RI "\fBuint32_t\fP \fBbtrExtData\fP {}"
.br
.ti -1c
.RI "std::vector< \fBuint8_t\fP > \fBreservedCanFdExtFrameData\fP {}"
.br
.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_FD_ERROR_64\&. 

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

.PP
bit rate used in arbitration phase CAN-FD bit timing configuration for arbiration phase, may be 0, if not supported by hardware/driver
.PP
.IP "\(bu" 2
Bit 0-7: Quartz Frequency
.IP "\(bu" 2
Bit 8-15: Prescaler
.IP "\(bu" 2
Bit 16-23: BTL Cycles
.IP "\(bu" 2
Bit 24-31: Sampling Point 
.PP

.SS "\fBuint32_t\fP Vector::BLF::CanFdErrorFrame64::btrCfgData {}"

.PP
bit rate used in data phase CAN-FD bit timing configuration for arbiration phase, may be 0, if not supported by hardware/driver\&. See btrCfgArb\&. 
.SS "\fBuint8_t\fP Vector::BLF::CanFdErrorFrame64::channel {}"

.PP
application channel Channel the frame was sent or received\&. 
.SS "\fBuint32_t\fP Vector::BLF::CanFdErrorFrame64::crc {}"
CRC checksum of corrupted message\&. 
.SS "std::vector<\fBuint8_t\fP> Vector::BLF::CanFdErrorFrame64::data {}"

.PP
CAN FD data\&. CAN FD data bytes (the actual length may be shorter than 64 bytes, according to the value of dlc, e\&.g\&. when DLC is 12 data has length 24) 
.SS "\fBuint8_t\fP Vector::BLF::CanFdErrorFrame64::dlc {}"

.PP
CAN dlc\&. Data length code of the corrupted message\&. 
.SS "\fBuint8_t\fP Vector::BLF::CanFdErrorFrame64::ecc {}"
Content of Philips SJA1000 Error Code Capture register, or the Vector CAN-Core error register\&. See field ecc of \fBCanErrorFrameExt\fP\&. 
.SS "\fBuint16_t\fP Vector::BLF::CanFdErrorFrame64::errorCodeExt {}"
Extended error flags\&. See field flagsExt of \fBCanErrorFrameExt\fP\&. 
.SS "\fBuint16_t\fP Vector::BLF::CanFdErrorFrame64::errorPosition {}"

.PP
error position as bit offset Bit position of the error frame in the corrupted message\&. 
.SS "\fBuint8_t\fP Vector::BLF::CanFdErrorFrame64::extDataOffset {}"
offset if extDataOffset is used 
.SS "\fBuint16_t\fP Vector::BLF::CanFdErrorFrame64::extFlags {}"

.PP
FD specific flags\&. CAN-FD specific flags\&.
.PP
.IP "\(bu" 2
Bit 0-3 Meaning:
.IP "  \(bu" 4
unused
.PP

.IP "\(bu" 2
Bit 0-4 Meaning:
.IP "  \(bu" 4
0: Error in Arbitration Phase
.IP "  \(bu" 4
1: Error in Data Phase
.PP

.IP "\(bu" 2
Bit 5 Meaning:
.IP "  \(bu" 4
0: ESI is 0
.IP "  \(bu" 4
1: ESI is 1
.PP

.IP "\(bu" 2
Bit 6 Meaning
.IP "  \(bu" 4
0: BRS is 0
.IP "  \(bu" 4
1: BRS is 1
.PP

.IP "\(bu" 2
Bit 7 Meaning
.IP "  \(bu" 4
0: EDL is 0
.IP "  \(bu" 4
1: EDL is 1 
.PP

.PP

.SS "\fBuint16_t\fP Vector::BLF::CanFdErrorFrame64::flags {}"
Defines what additional information is valid\&. See field flags of \fBCanErrorFrameExt\fP\&. 
.SS "\fBuint32_t\fP Vector::BLF::CanFdErrorFrame64::frameLength {}"

.PP
message length in ns Length of the error frame in nanoseconds (time difference between Start Of Frame and End Of Frame)
.PP
without 3 inter frame space bits and by Rx-message also without 1 End-Of-Frame bit 
.SS "\fBuint32_t\fP Vector::BLF::CanFdErrorFrame64::id {}"

.PP
CAN ID\&. Message ID of the corrupted message\&. 
.SS "\fBuint8_t\fP Vector::BLF::CanFdErrorFrame64::reservedCanFdErrorFrame1 {}"
resered 
.SS "\fBuint16_t\fP Vector::BLF::CanFdErrorFrame64::reservedCanFdErrorFrame2 {}"
reserved 
.SS "std::vector<\fBuint8_t\fP> Vector::BLF::CanFdErrorFrame64::reservedCanFdErrorFrame64 {}"
reserved
.PP
\fBNote\fP
.RS 4
This usually has 8 data bytes, when \fBCanFdExtFrameData\fP is not used\&. 
.RE
.PP

.SS "\fBuint32_t\fP Vector::BLF::CanFdErrorFrame64::timeOffsetBrsNs {}"

.PP
time offset of brs field Time offset of bit rate switch within BRS field in nanoseconds 
.SS "\fBuint32_t\fP Vector::BLF::CanFdErrorFrame64::timeOffsetCrcDelNs {}"

.PP
time offset of brs field Time offset of bit rate switch within CRC delimiter field in nanoseconds 
.SS "\fBuint8_t\fP Vector::BLF::CanFdErrorFrame64::validDataBytes {}"

.PP
Valid payload length of data\&. Number of data bytes of the corrupted message\&. 

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