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

.SH SYNOPSIS
.br
.PP
.PP
\fR#include <CanFdMessage64\&.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 \fBtxCount\fP {}"
.br
.RI "txRequiredCount (4 bits), txReqCount (4 Bits) "
.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 \fBflags\fP {}"
.br
.RI "flags "
.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 crc delimiter field "
.ti -1c
.RI "\fBuint16_t\fP \fBbitCount\fP {}"
.br
.RI "complete message length in bits "
.ti -1c
.RI "\fBuint8_t\fP \fBdir\fP {}"
.br
.ti -1c
.RI "\fBuint8_t\fP \fBextDataOffset\fP {}"
.br
.ti -1c
.RI "\fBuint32_t\fP \fBcrc\fP {}"
.br
.RI "CRC for CAN\&. "
.ti -1c
.RI "std::vector< \fBuint8_t\fP > \fBdata\fP {}"
.br
.RI "CAN FD data\&. "
.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_MESSAGE_64\&. 

CAN FD data frame, or CAN data- or remote frame on a CAN FD channel\&. 
.SH "Member Function Documentation"
.PP 
.SS "\fBuint32_t\fP Vector::BLF::CanFdMessage64::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::CanFdMessage64::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::CanFdMessage64::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::CanFdMessage64::bitCount {}"

.PP
complete message length in bits Bit count of the message 
.SS "\fBuint32_t\fP Vector::BLF::CanFdMessage64::btrCfgArb {}"

.PP
bit rate used in arbitration phase CAN- or CAN-FD bit timing configuration for arbitration 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::CanFdMessage64::btrCfgData {}"

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

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

.PP
CAN FD data\&. Data bytes (the actual length may be shorter than 64 bytes, according to the value of dlc)\&. 
.SS "\fBuint8_t\fP Vector::BLF::CanFdMessage64::dir {}"
Direction of the message 
.SS "\fBuint8_t\fP Vector::BLF::CanFdMessage64::dlc {}"

.PP
CAN dlc\&. Data length code of frame\&.
.PP
.IP "\(bu" 2
DLC=0-8: CAN=0-8, CAN FD=0-8
.IP "\(bu" 2
DLC=9: CAN=8, CAN FD=12
.IP "\(bu" 2
DLC=10: CAN=8, CAN FD=16
.IP "\(bu" 2
DLC=11: CAN=8, CAN FD=20
.IP "\(bu" 2
DLC=12: CAN=8, CAN FD=24
.IP "\(bu" 2
DLC=13: CAN=8, CAN FD=32
.IP "\(bu" 2
DLC=14: CAN=8, CAN FD=48
.IP "\(bu" 2
DLC=15: CAN=8, CAN FD=64 
.PP

.SS "\fBuint8_t\fP Vector::BLF::CanFdMessage64::extDataOffset {}"
offset if extDataOffset is used 
.SS "\fBuint32_t\fP Vector::BLF::CanFdMessage64::flags {}"

.PP
flags 
.IP "\(bu" 2
Bit#=0 (0x0001): Must be 0
.IP "\(bu" 2
Bit#=1 (0x0002): Reserved, for internal use
.IP "\(bu" 2
Bit#=2 (0x0004): 1=NERR (1=single wire on low speed CAN)
.IP "\(bu" 2
Bit#=3 (0x0008): 1=High voltage wake up
.IP "\(bu" 2
Bit#=4 (0x0010): 1=Remote frame (only CAN)
.IP "\(bu" 2
Bit#=5 (0x0020): Reserved, must be 0
.IP "\(bu" 2
Bit#=6 (0x0040): 1=Tx Acknowledge
.IP "\(bu" 2
Bit#=7 (0x0080): 1=Tx Request
.IP "\(bu" 2
Bit#=8 (0x0100): Reserved, must be 0
.IP "\(bu" 2
Bit#=9 (0x0200): SRR (CAN FD)
.IP "\(bu" 2
Bit#=10 (0x0400): R0
.IP "\(bu" 2
Bit#=11 (0x0800): R1
.IP "\(bu" 2
Bit#=12 (0x1000): EDL, 0: CAN frame, 1: CAN FD frame
.IP "\(bu" 2
Bit#=13 (0x2000): BRS (CAN FD)
.IP "\(bu" 2
Bit#=14 (0x4000): ESI
.IP "\(bu" 2
Bit#=15 (0x8000): Reserved, must be 0
.IP "\(bu" 2
Bit#=16 (0x10000): Reserved, must be 0
.IP "\(bu" 2
Bit#=17 (0x20000): 1=Frame is part of a burst
.IP "\(bu" 2
Bit#=18-31: Reserved, must be 0 
.PP

.SS "\fBuint32_t\fP Vector::BLF::CanFdMessage64::frameLength {}"

.PP
message length in ns Message duration [in ns]\&. Not including 3 interframe-space bit times and by Rx-messages also not including 1 end-of-frame bit time 
.SS "\fBuint32_t\fP Vector::BLF::CanFdMessage64::id {}"

.PP
CAN ID\&. Frame identifier\&. 
.SS "\fBuint32_t\fP Vector::BLF::CanFdMessage64::timeOffsetBrsNs {}"

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

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

.PP
txRequiredCount (4 bits), txReqCount (4 Bits) (Bits 0-3) Number of required tranmission attempts, (Bits 4-7) Max Number of transmission attempts\&. 
.SS "\fBuint8_t\fP Vector::BLF::CanFdMessage64::validDataBytes {}"

.PP
Valid payload length of data\&. Valid payload length of data, can differ from DLC value\&. 

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