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

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

.in +1c
.ti -1c
.RI "enum \fBFlags\fP : uint32_t { \fBKLineEvent\fP = 0x00000001, \fBDiagRequest\fP = 0x00000002, \fBSingleByte\fP = 0x00000004, \fBCompactByte\fP = 0x00000008 }"
.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 "\fBSerialEvent\fP (\fBconst\fP \fBSerialEvent\fP &)=\fBdefault\fP"
.br
.ti -1c
.RI "\fBSerialEvent\fP & \fBoperator=\fP (\fBconst\fP \fBSerialEvent\fP &)=\fBdefault\fP"
.br
.ti -1c
.RI "\fBSerialEvent\fP (\fBSerialEvent\fP &&)=\fBdefault\fP"
.br
.ti -1c
.RI "\fBSerialEvent\fP & \fBoperator=\fP (\fBSerialEvent\fP &&)=\fBdefault\fP"
.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 "\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 "\fBuint16_t\fP \fBcalculateHeaderSize\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 "\fBuint32_t\fP \fBflags\fP {}"
.br
.ti -1c
.RI "\fBuint32_t\fP \fBport\fP {}"
.br
.RI "channel of event "
.ti -1c
.RI "\fBuint32_t\fP \fBbaudrate\fP {}"
.br
.RI "baudrate at which this event was transmitted (optional) "
.ti -1c
.RI "\fBuint32_t\fP \fBreservedSerialEvent\fP {}"
.br
.ti -1c
.RI "\fBGeneralSerialEvent\fP \fBgeneral\fP {}"
.br
.ti -1c
.RI "\fBSingleByteSerialEvent\fP \fBsingleByte\fP {}"
.br
.ti -1c
.RI "\fBCompactSerialEvent\fP \fBcompact\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
.SH "Detailed Description"
.PP 
SERIAL_EVENT\&. 

serial event 
.SH "Member Enumeration Documentation"
.PP 
.SS "\fBenum\fP \fBVector::BLF::SerialEvent::Flags\fP : \fBuint32_t\fP"
enumeration for flags 
.PP
\fBEnumerator\fP
.in +1c
.TP
\fB\fIKLineEvent \fP\fP
K-Line event 
.TP
\fB\fIDiagRequest \fP\fP
diagnostic request
.PP
only valid if KLineEvent is set 
.TP
\fB\fISingleByte \fP\fP
single byte
.PP
optimization for logging single bytes 
.TP
\fB\fICompactByte \fP\fP
compact byte
.PP
optimization for logging a few bytes without additional timestamps 
.SH "Member Function Documentation"
.PP 
.SS "\fBuint32_t\fP Vector::BLF::SerialEvent::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::ObjectHeader\fP\&.
.SS "\fBvoid\fP Vector::BLF::SerialEvent::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::ObjectHeader\fP\&.
.SS "\fBvoid\fP Vector::BLF::SerialEvent::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::ObjectHeader\fP\&.
.SH "Member Data Documentation"
.PP 
.SS "\fBuint32_t\fP Vector::BLF::SerialEvent::baudrate {}"

.PP
baudrate at which this event was transmitted (optional) baudrate at which this event was transmitted (optional) 
.SS "\fBCompactSerialEvent\fP Vector::BLF::SerialEvent::compact {}"
compact serial event 
.SS "\fBuint32_t\fP Vector::BLF::SerialEvent::flags {}"
flags 
.SS "\fBGeneralSerialEvent\fP Vector::BLF::SerialEvent::general {}"
general serial event 
.SS "\fBuint32_t\fP Vector::BLF::SerialEvent::port {}"

.PP
channel of event channel of event 
.SS "\fBuint32_t\fP Vector::BLF::SerialEvent::reservedSerialEvent {}"
reserved 
.SS "\fBSingleByteSerialEvent\fP Vector::BLF::SerialEvent::singleByte {}"
single byte serial event 

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