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

.SH SYNOPSIS
.br
.PP
.PP
\fR#include <LinMessage\&.h>\fP
.PP
Inherits \fBVector::BLF::ObjectHeader\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
.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
.SS "Public Attributes"

.in +1c
.ti -1c
.RI "\fBuint16_t\fP \fBchannel\fP {}"
.br
.RI "application channel "
.ti -1c
.RI "\fBuint8_t\fP \fBid\fP {}"
.br
.RI "LIN ID\&. "
.ti -1c
.RI "\fBuint8_t\fP \fBdlc\fP {}"
.br
.RI "LIN DLC\&. "
.ti -1c
.RI "std::array< \fBuint8_t\fP, 8 > \fBdata\fP {}"
.br
.ti -1c
.RI "\fBuint8_t\fP \fBfsmId\fP {}"
.br
.ti -1c
.RI "\fBuint8_t\fP \fBfsmState\fP {}"
.br
.ti -1c
.RI "\fBuint8_t\fP \fBheaderTime\fP {}"
.br
.ti -1c
.RI "\fBuint8_t\fP \fBfullTime\fP {}"
.br
.ti -1c
.RI "\fBuint16_t\fP \fBcrc\fP {}"
.br
.ti -1c
.RI "\fBuint8_t\fP \fBdir\fP {}"
.br
.RI "direction "
.ti -1c
.RI "\fBuint8_t\fP \fBreservedLinMessage1\fP {}"
.br
.ti -1c
.RI "\fBuint32_t\fP \fBreservedLinMessage2\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
.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 
LIN_MESSAGE\&. 


.PP
\fBDeprecated\fP
.RS 4

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

.PP
application channel Channel number where the frame sent/received\&. 
.SS "\fBuint16_t\fP Vector::BLF::LinMessage::crc {}"
Checksum byte value 
.SS "std::array<\fBuint8_t\fP, 8> Vector::BLF::LinMessage::data {}"
Databyte values 
.SS "\fBuint8_t\fP Vector::BLF::LinMessage::dir {}"

.PP
direction Direction of bus events
.IP "\(bu" 2
0: Rx (received)
.IP "\(bu" 2
1: Tx (transmit receipt)
.IP "\(bu" 2
2: Tx Request (transmit request) 
.PP

.SS "\fBuint8_t\fP Vector::BLF::LinMessage::dlc {}"

.PP
LIN DLC\&. Frame length 
.SS "\fBuint8_t\fP Vector::BLF::LinMessage::fsmId {}"
Slave Identifier in the Final State Machine (obsolete) 
.SS "\fBuint8_t\fP Vector::BLF::LinMessage::fsmState {}"
State Identifier of a Slave in the Final State Machine (obsolete) 
.SS "\fBuint8_t\fP Vector::BLF::LinMessage::fullTime {}"
Duration of the entire frame [in bit times] 
.SS "\fBuint8_t\fP Vector::BLF::LinMessage::headerTime {}"
Duration of the frame header [in bit times] 
.SS "\fBuint8_t\fP Vector::BLF::LinMessage::id {}"

.PP
LIN ID\&. Frame identifier 
.SS "\fBuint8_t\fP Vector::BLF::LinMessage::reservedLinMessage1 {}"
reserved 
.SS "\fBuint32_t\fP Vector::BLF::LinMessage::reservedLinMessage2 {}"
reserved 

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