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

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

.in +1c
.ti -1c
.RI "enum \fBFlags\fP : uint8_t { \fBTX\fP = (1 << 0), \fBNERR\fP = (1 << 5), \fBWU\fP = (1 << 6), \fBRTR\fP = (1 << 7) }"
.br
.ti -1c
.RI "enum \fBCanFdFlags\fP : uint8_t { \fBEDL\fP = (1 << 0), \fBBRS\fP = (1 << 1), \fBESI\fP = (1 << 2) }"
.br
.in -1c

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
.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 \fBflags\fP {}"
.br
.RI "CAN dir & rtr\&. "
.ti -1c
.RI "uint8_t \fBdlc\fP {}"
.br
.RI "CAN dlc\&. "
.ti -1c
.RI "uint32_t \fBid\fP {}"
.br
.RI "CAN ID\&. "
.ti -1c
.RI "uint32_t \fBframeLength\fP {}"
.br
.RI "message length in ns - without 3 inter frame space bits and by Rx-message also without 1 End-Of-Frame bit "
.ti -1c
.RI "uint8_t \fBarbBitCount\fP {}"
.br
.RI "bit count of arbitration phase "
.ti -1c
.RI "uint8_t \fBcanFdFlags\fP {}"
.br
.RI "CAN FD flags\&. "
.ti -1c
.RI "uint8_t \fBvalidDataBytes\fP {}"
.br
.RI "Valid payload length of data\&. "
.ti -1c
.RI "uint8_t \fBreservedCanFdMessage1\fP {}"
.br
.ti -1c
.RI "uint32_t \fBreservedCanFdMessage2\fP {}"
.br
.ti -1c
.RI "std::array< uint8_t, 64 > \fBdata\fP {}"
.br
.RI "CAN FD data\&. "
.ti -1c
.RI "uint32_t \fBreservedCanFdMessage3\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
.SH "Detailed Description"
.PP 
CAN_FD_MESSAGE\&. 
.SH "Member Enumeration Documentation"
.PP 
.SS "enum \fBVector::BLF::CanFdMessage::CanFdFlags\fP : uint8_t"
enumeration for canFdFlags 
.PP
\fBEnumerator\fP
.in +1c
.TP
\f(BIEDL \fP
extended data length 
.TP
\f(BIBRS \fP
bit rate switch 
.TP
\f(BIESI \fP
error state indicator 
.SS "enum \fBVector::BLF::CanFdMessage::Flags\fP : uint8_t"
enumeration for flags 
.PP
\fBEnumerator\fP
.in +1c
.TP
\f(BITX \fP
transmit direction 
.TP
\f(BINERR \fP
single wire operation 
.TP
\f(BIWU \fP
wake up message (high voltage) 
.TP
\f(BIRTR \fP
remote transmission request 
.SH "Member Function Documentation"
.PP 
.SS "uint32_t Vector::BLF::CanFdMessage::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::CanFdMessage::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::CanFdMessage::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 "uint8_t Vector::BLF::CanFdMessage::flags {}"

.PP
CAN dir & rtr\&. CAN Message \fBFlags\fP

.PP
CAN dir, rtr, wu & nerr encoded into flags 
.SS "uint8_t Vector::BLF::CanFdMessage::reservedCanFdMessage1 {}"
reserved 
.SS "uint32_t Vector::BLF::CanFdMessage::reservedCanFdMessage2 {}"
reserved 
.SS "uint32_t Vector::BLF::CanFdMessage::reservedCanFdMessage3 {}"
reserved 

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