Vector BLF
Vector::BLF::EventComment Struct Referencefinal

EVENT_COMMENT. More...

#include <EventComment.h>

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

Public Member Functions

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)
 
void read (AbstractFile &is) override
 
void write (AbstractFile &os) override
 
WORD calculateHeaderSize () const override
 
DWORD calculateObjectSize () 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 commentedEventType {}
 commented event type More...
 
DWORD textLength {}
 text length in bytes More...
 
ULONGLONG reservedEventComment {}
 
std::string text {}
 text in MBCS More...
 
- 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...
 

Additional Inherited Members

- Public Types inherited from Vector::BLF::ObjectHeader
enum  ObjectFlags : DWORD { TimeTenMics = 0x00000001 , TimeOneNans = 0x00000002 }
 

Detailed Description

EVENT_COMMENT.

Comment of an event. The comment can be set in Trace Window.

Member Function Documentation

◆ calculateObjectSize()

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

Calculates the objectSize

Returns
object size

Reimplemented from Vector::BLF::ObjectHeaderBase.

◆ read()

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

Read the data of this object

Parameters
isinput stream

Reimplemented from Vector::BLF::ObjectHeaderBase.

◆ write()

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

Write the data of this object

Parameters
osoutput stream

Reimplemented from Vector::BLF::ObjectHeaderBase.

Member Data Documentation

◆ commentedEventType

DWORD Vector::BLF::EventComment::commentedEventType {}

commented event type

Type of the commented event

◆ reservedEventComment

ULONGLONG Vector::BLF::EventComment::reservedEventComment {}

reserved

◆ text

std::string Vector::BLF::EventComment::text {}

text in MBCS

Comment text.

◆ textLength

DWORD Vector::BLF::EventComment::textLength {}

text length in bytes

Length of text without ending 0.


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