Vector BLF
Loading...
Searching...
No Matches
Vector::BLF::ObjectHeader2 Struct Reference

Object header. More...

#include <ObjectHeader2.h>

Inheritance diagram for Vector::BLF::ObjectHeader2:
Vector::BLF::ObjectHeaderBase Vector::BLF::Most150AllocTab Vector::BLF::Most150Message Vector::BLF::Most150MessageFragment Vector::BLF::Most150Pkt Vector::BLF::Most150PktFragment Vector::BLF::Most50Message Vector::BLF::Most50Pkt Vector::BLF::MostAllocTab Vector::BLF::MostDataLost Vector::BLF::MostEcl Vector::BLF::MostEthernetPkt Vector::BLF::MostEthernetPktFragment Vector::BLF::MostGenReg Vector::BLF::MostHwMode Vector::BLF::MostNetState Vector::BLF::MostPkt2 Vector::BLF::MostReg Vector::BLF::MostStatisticEx Vector::BLF::MostStress Vector::BLF::MostSystemEvent Vector::BLF::MostTrigger Vector::BLF::MostTxLight

Public Types

enum  ObjectFlags : uint32_t { TimeTenMics = 0x00000001 , TimeOneNans = 0x00000002 }
 
enum  TimeStampStatus : uint8_t { Orig = 0x01 , SwHw = 0x02 , User = 0x10 }
 

Public Member Functions

 ObjectHeader2 (const ObjectType objectType)
 
void read (AbstractFile &is) override
 
void write (AbstractFile &os) override
 
uint16_t calculateHeaderSize () const override
 
uint32_t calculateObjectSize () const override
 
- Public Member Functions inherited from Vector::BLF::ObjectHeaderBase
 ObjectHeaderBase (const uint16_t headerVersion, const ObjectType objectType)
 
 ObjectHeaderBase (const ObjectHeaderBase &)=default
 
ObjectHeaderBaseoperator= (const ObjectHeaderBase &)=default
 
 ObjectHeaderBase (ObjectHeaderBase &&)=default
 
ObjectHeaderBaseoperator= (ObjectHeaderBase &&)=default
 

Public Attributes

uint32_t objectFlags {ObjectFlags::TimeOneNans}
 object flags
 
uint8_t timeStampStatus {}
 time stamp status
 
uint8_t reservedObjectHeader {0}
 
uint16_t objectVersion {0}
 object specific version
 
uint64_t objectTimeStamp {0}
 object timestamp
 
uint64_t originalTimeStamp {0}
 original object timestamp
 
- Public Attributes inherited from Vector::BLF::ObjectHeaderBase
uint32_t signature {ObjectSignature}
 signature (ObjectSignature)
 
uint16_t headerSize {}
 sizeof object header
 
uint16_t headerVersion {}
 header version (1)
 
uint32_t objectSize {}
 object size
 
ObjectType objectType {ObjectType::UNKNOWN}
 object type
 

Detailed Description

Object header.

Object header. Version 2.

Member Enumeration Documentation

◆ ObjectFlags

enumeration for objectFlags

Enumerator
TimeTenMics 

10 micro second timestamp

Object time stamp is saved as multiple of ten microseconds. (BL_OBJ_FLAG_TIME_TEN_MICS)

TimeOneNans 

1 nano second timestamp

Object time stamp is saved in nanoseconds. (BL_OBJ_FLAG_TIME_ONE_NANS)

◆ TimeStampStatus

enumeration for timeStampStatus

Enumerator
Orig 

1: valid orig. timestamp

Determines whether original timestamp member is valid (1) or not (0).

SwHw 

1: sw generated ts; 0: hw

Timestamp is generated by software (1) or by hardware (0).

User 

protocol specific meaning

This bit has protocol specific meaning.

Member Function Documentation

◆ calculateHeaderSize()

uint16_t Vector::BLF::ObjectHeader2::calculateHeaderSize ( ) const
overridevirtual

Calculates the headerSize

Returns
header size

Reimplemented from Vector::BLF::ObjectHeaderBase.

◆ calculateObjectSize()

uint32_t Vector::BLF::ObjectHeader2::calculateObjectSize ( ) const
overridevirtual

Calculates the objectSize

Returns
object size

Reimplemented from Vector::BLF::ObjectHeaderBase.

◆ read()

void Vector::BLF::ObjectHeader2::read ( AbstractFile & is)
overridevirtual

Read the data of this object

Parameters
isinput stream

Reimplemented from Vector::BLF::ObjectHeaderBase.

◆ write()

void Vector::BLF::ObjectHeader2::write ( AbstractFile & os)
overridevirtual

Write the data of this object

Parameters
osoutput stream

Reimplemented from Vector::BLF::ObjectHeaderBase.

Member Data Documentation

◆ objectFlags

uint32_t Vector::BLF::ObjectHeader2::objectFlags {ObjectFlags::TimeOneNans}

object flags

Unit of object timestamp.

◆ objectTimeStamp

uint64_t Vector::BLF::ObjectHeader2::objectTimeStamp {0}

object timestamp

Time stamp of this object in the unit specified in objectFlags.

◆ objectVersion

uint16_t Vector::BLF::ObjectHeader2::objectVersion {0}

object specific version

Object specific version, has to be set to 0 unless stated otherwise in the description of a specific event.

Note
can be set in event class constructor

◆ originalTimeStamp

uint64_t Vector::BLF::ObjectHeader2::originalTimeStamp {0}

original object timestamp

Original timestamp in the unit specified in objectFlags.

◆ reservedObjectHeader

uint8_t Vector::BLF::ObjectHeader2::reservedObjectHeader {0}

reserved

◆ timeStampStatus

uint8_t Vector::BLF::ObjectHeader2::timeStampStatus {}

time stamp status

Bit field.


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