.TH "Vector::BLF::LinMessageDescriptor" 3 "Vector BLF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
Vector::BLF::LinMessageDescriptor
.SH SYNOPSIS
.br
.PP
.PP
\fR#include <LinMessageDescriptor\&.h>\fP
.PP
Inherits \fBVector::BLF::LinSynchFieldEvent\fP\&.
.PP
Inherited by \fBVector::BLF::LinDatabyteTimestampEvent\fP, and \fBVector::BLF::LinSendError2\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::LinSynchFieldEvent\fP
.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::LinBusEvent\fP
.in +1c
.ti -1c
.RI "\fBLinBusEvent\fP (const LinBusEvent &)=default"
.br
.ti -1c
.RI "LinBusEvent & \fBoperator=\fP (const LinBusEvent &)=default"
.br
.ti -1c
.RI "\fBLinBusEvent\fP (LinBusEvent &&)=default"
.br
.ti -1c
.RI "LinBusEvent & \fBoperator=\fP (LinBusEvent &&)=default"
.br
.in -1c
.SS "Public Attributes"

.in +1c
.ti -1c
.RI "uint16_t \fBsupplierId\fP {}"
.br
.RI "LIN Sub-Identifier - Supplier ID\&. "
.ti -1c
.RI "uint16_t \fBmessageId\fP {}"
.br
.RI "LIN Sub-Identifier - Message ID (16 bits)\&. "
.ti -1c
.RI "uint8_t \fBnad\fP {}"
.br
.RI "LIN Sub-Identifier - NAD\&. "
.ti -1c
.RI "uint8_t \fBid\fP {}"
.br
.RI "LIN ID\&. "
.ti -1c
.RI "uint8_t \fBdlc\fP {}"
.br
.RI "LIN DLC\&. "
.ti -1c
.RI "uint8_t \fBchecksumModel\fP {}"
.br
.RI "LIN checksum model\&. "
.in -1c

Public Attributes inherited from \fBVector::BLF::LinSynchFieldEvent\fP
.in +1c
.ti -1c
.RI "uint64_t \fBsynchBreakLength\fP {}"
.br
.RI "Sync Break Length in ns\&. "
.ti -1c
.RI "uint64_t \fBsynchDelLength\fP {}"
.br
.RI "Sync Delimiter Length in ns\&. "
.in -1c

Public Attributes inherited from \fBVector::BLF::LinBusEvent\fP
.in +1c
.ti -1c
.RI "uint64_t \fBsof\fP {}"
.br
.RI "Start Of Frame timestamp\&. "
.ti -1c
.RI "uint32_t \fBeventBaudrate\fP {}"
.br
.RI "Baudrate of the event in bit/sec\&. "
.ti -1c
.RI "uint16_t \fBchannel\fP {}"
.br
.RI "application channel "
.ti -1c
.RI "uint16_t \fBreservedLinBusEvent\fP {}"
.br
.in -1c
.SH "Detailed Description"
.PP 
Common header of LIN bus events containing LIN header data 
.SH "Member Function Documentation"
.PP 
.SS "uint32_t Vector::BLF::LinMessageDescriptor::calculateObjectSize () const\fR [override]\fP, \fR [virtual]\fP"

.PP
Calculates the objectSize

.PP
\fBReturns\fP
.RS 4
object size    
.RE
.PP

.PP
Reimplemented from \fBVector::BLF::LinBusEvent\fP\&.
.PP
Reimplemented in \fBVector::BLF::LinReceiveError2\fP, \fBVector::BLF::LinSendError2\fP, \fBVector::BLF::LinShortOrSlowResponse2\fP, and \fBVector::BLF::LinShortOrSlowResponse\fP\&.
.SS "void Vector::BLF::LinMessageDescriptor::read (\fBAbstractFile\fP & is)\fR [override]\fP, \fR [virtual]\fP"

.PP
Read the data of this object

.PP
\fBParameters\fP
.RS 4
\fIis\fP input stream    
.RE
.PP

.PP
Reimplemented from \fBVector::BLF::LinBusEvent\fP\&.
.PP
Reimplemented in \fBVector::BLF::LinReceiveError2\fP, \fBVector::BLF::LinSendError2\fP, \fBVector::BLF::LinShortOrSlowResponse2\fP, and \fBVector::BLF::LinShortOrSlowResponse\fP\&.
.SS "void Vector::BLF::LinMessageDescriptor::write (\fBAbstractFile\fP & os)\fR [override]\fP, \fR [virtual]\fP"

.PP
Write the data of this object

.PP
\fBParameters\fP
.RS 4
\fIos\fP output stream    
.RE
.PP

.PP
Reimplemented from \fBVector::BLF::LinBusEvent\fP\&.
.PP
Reimplemented in \fBVector::BLF::LinReceiveError2\fP, \fBVector::BLF::LinSendError2\fP, \fBVector::BLF::LinShortOrSlowResponse2\fP, and \fBVector::BLF::LinShortOrSlowResponse\fP\&.
.SH "Member Data Documentation"
.PP 
.SS "uint8_t Vector::BLF::LinMessageDescriptor::checksumModel {}"

.PP
LIN checksum model\&. Expected checksum model of checksum value\&. Only valid if objectVersion >= 1\&. 
.SS "uint8_t Vector::BLF::LinMessageDescriptor::dlc {}"

.PP
LIN DLC\&. Frame length [in bytes] 
.SS "uint8_t Vector::BLF::LinMessageDescriptor::id {}"

.PP
LIN ID\&. Frame identifier (6-bit) 
.SS "uint16_t Vector::BLF::LinMessageDescriptor::messageId {}"

.PP
LIN Sub-Identifier - Message ID (16 bits)\&. LIN protocol 2\&.0: Message identifier (16-bit) of the frame as it is specified in LDF in the list of transmitter’s configurable frames\&.

.PP
LIN protocol 2\&.1: Position index of the frame as it is specified in LDF in the list of transmitter’s configurable frames\&. 
.SS "uint8_t Vector::BLF::LinMessageDescriptor::nad {}"

.PP
LIN Sub-Identifier - NAD\&. Configured Node Address of the frame’s transmitter as it is specified in LDF\&. LIN protocol 2\&.0 and higher 
.SS "uint16_t Vector::BLF::LinMessageDescriptor::supplierId {}"

.PP
LIN Sub-Identifier - Supplier ID\&. Supplier identifier of the frame’s transmitter as it is specified in LDF\&. LIN protocol 2\&.0 and higher 

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