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

.SH SYNOPSIS
.br
.PP
.PP
\fR#include <CanMessage2\&.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 \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 "std::vector< uint8_t > \fBdata\fP {}"
.br
.RI "CAN data\&. "
.ti -1c
.RI "uint32_t \fBframeLength\fP {}"
.br
.RI "message length in ns "
.ti -1c
.RI "uint8_t \fBbitCount\fP {}"
.br
.RI "complete message length in bits "
.ti -1c
.RI "uint8_t \fBreservedCanMessage1\fP {}"
.br
.ti -1c
.RI "uint16_t \fBreservedCanMessage2\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 
CAN_MESSAGE2\&. 

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

.PP
complete message length in bits Total number of bits of the message including EOF and Interframe space [in bits] 
.SS "uint16_t Vector::BLF::CanMessage2::channel {}"

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

.PP
CAN data\&. CAN data bytes 
.SS "uint8_t Vector::BLF::CanMessage2::dlc {}"

.PP
CAN dlc\&. Data length code of frame (number of valid data bytes, max\&. 8) 
.SS "uint8_t Vector::BLF::CanMessage2::flags {}"

.PP
CAN dir & rtr\&. CAN Message Flags

.PP
CAN dir, rtr, wu & nerr encoded into flags:
.IP "\(bu" 2
Bit 0: TX
.IP "\(bu" 2
Bit 5: NERR
.IP "\(bu" 2
Bit 6: WU
.IP "\(bu" 2
Bit 7: RTR 
.PP

.SS "uint32_t Vector::BLF::CanMessage2::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 "uint32_t Vector::BLF::CanMessage2::id {}"

.PP
CAN ID\&. Frame identifier\&. 
.SS "uint8_t Vector::BLF::CanMessage2::reservedCanMessage1 {}"
reserved 
.SS "uint16_t Vector::BLF::CanMessage2::reservedCanMessage2 {}"
reserved 

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