Vector BLF
Vector::BLF::SerialEvent Struct Referencefinal

SERIAL_EVENT. More...

#include <SerialEvent.h>

Inheritance diagram for Vector::BLF::SerialEvent:
Inheritance graph
Collaboration diagram for Vector::BLF::SerialEvent:
Collaboration graph

Public Types

enum  Flags : DWORD { KLineEvent = 0x00000001 , DiagRequest = 0x00000002 , SingleByte = 0x00000004 , CompactByte = 0x00000008 }
 
- Public Types inherited from Vector::BLF::ObjectHeader
enum  ObjectFlags : DWORD { TimeTenMics = 0x00000001 , TimeOneNans = 0x00000002 }
 

Public Member Functions

 SerialEvent (const SerialEvent &)=default
 
SerialEventoperator= (const SerialEvent &)=default
 
 SerialEvent (SerialEvent &&)=default
 
SerialEventoperator= (SerialEvent &&)=default
 
void read (AbstractFile &is) override
 
void write (AbstractFile &os) override
 
DWORD calculateObjectSize () const override
 
- Public Member Functions inherited from Vector::BLF::ObjectHeader
 ObjectHeader (const ObjectType objectType, const WORD objectVersion=0)
 
WORD calculateHeaderSize () const override
 
- Public Member Functions inherited from Vector::BLF::ObjectHeaderBase
 ObjectHeaderBase (const WORD headerVersion, const ObjectType objectType)
 
 ObjectHeaderBase (const ObjectHeaderBase &)=default
 
ObjectHeaderBaseoperator= (const ObjectHeaderBase &)=default
 
 ObjectHeaderBase (ObjectHeaderBase &&)=default
 
ObjectHeaderBaseoperator= (ObjectHeaderBase &&)=default
 

Public Attributes

DWORD flags {}
 
DWORD port {}
 channel of event More...
 
DWORD baudrate {}
 baudrate at which this event was transmitted (optional) More...
 
DWORD reservedSerialEvent {}
 
GeneralSerialEvent general {}
 
SingleByteSerialEvent singleByte {}
 
CompactSerialEvent compact {}
 
- Public Attributes inherited from Vector::BLF::ObjectHeader
DWORD objectFlags {ObjectFlags::TimeOneNans}
 object flags More...
 
WORD clientIndex {}
 client index of send node
 
WORD objectVersion {0}
 object specific version More...
 
ULONGLONG objectTimeStamp {}
 object timestamp More...
 
- Public Attributes inherited from Vector::BLF::ObjectHeaderBase
DWORD signature {ObjectSignature}
 signature (ObjectSignature) More...
 
WORD headerSize {}
 sizeof object header More...
 
WORD headerVersion {}
 header version (1) More...
 
DWORD objectSize {}
 object size More...
 
ObjectType objectType {}
 object type More...
 

Detailed Description

SERIAL_EVENT.

serial event

Member Enumeration Documentation

◆ Flags

enumeration for flags

Enumerator
KLineEvent 

K-Line event

DiagRequest 

diagnostic request

only valid if KLineEvent is set

SingleByte 

single byte

optimization for logging single bytes

CompactByte 

compact byte

optimization for logging a few bytes without additional timestamps

Member Function Documentation

◆ calculateObjectSize()

DWORD Vector::BLF::SerialEvent::calculateObjectSize ( ) const
overridevirtual

Calculates the objectSize

Returns
object size

Reimplemented from Vector::BLF::ObjectHeader.

◆ read()

void Vector::BLF::SerialEvent::read ( AbstractFile is)
overridevirtual

Read the data of this object

Parameters
isinput stream

Reimplemented from Vector::BLF::ObjectHeader.

◆ write()

void Vector::BLF::SerialEvent::write ( AbstractFile os)
overridevirtual

Write the data of this object

Parameters
osoutput stream

Reimplemented from Vector::BLF::ObjectHeader.

Member Data Documentation

◆ baudrate

DWORD Vector::BLF::SerialEvent::baudrate {}

baudrate at which this event was transmitted (optional)

baudrate at which this event was transmitted (optional)

◆ compact

CompactSerialEvent Vector::BLF::SerialEvent::compact {}

compact serial event

◆ flags

DWORD Vector::BLF::SerialEvent::flags {}

flags

◆ general

GeneralSerialEvent Vector::BLF::SerialEvent::general {}

general serial event

◆ port

DWORD Vector::BLF::SerialEvent::port {}

channel of event

channel of event

◆ reservedSerialEvent

DWORD Vector::BLF::SerialEvent::reservedSerialEvent {}

reserved

◆ singleByte

SingleByteSerialEvent Vector::BLF::SerialEvent::singleByte {}

single byte serial event


The documentation for this struct was generated from the following files: