.TH "Vector::BLF::ObjectHeader2" 3 "Vector BLF" \" -*- nroff -*- .ad l .nh .SH NAME Vector::BLF::ObjectHeader2 \- Object header\&. .SH SYNOPSIS .br .PP .PP \fR#include \fP .PP Inherits \fBVector::BLF::ObjectHeaderBase\fP\&. .PP Inherited by \fBVector::BLF::Most150AllocTab\fP, \fBVector::BLF::Most150Message\fP, \fBVector::BLF::Most150MessageFragment\fP, \fBVector::BLF::Most150Pkt\fP, \fBVector::BLF::Most150PktFragment\fP, \fBVector::BLF::Most50Message\fP, \fBVector::BLF::Most50Pkt\fP, \fBVector::BLF::MostAllocTab\fP, \fBVector::BLF::MostDataLost\fP, \fBVector::BLF::MostEcl\fP, \fBVector::BLF::MostEthernetPkt\fP, \fBVector::BLF::MostEthernetPktFragment\fP, \fBVector::BLF::MostGenReg\fP, \fBVector::BLF::MostHwMode\fP, \fBVector::BLF::MostNetState\fP, \fBVector::BLF::MostPkt2\fP, \fBVector::BLF::MostReg\fP, \fBVector::BLF::MostStatisticEx\fP, \fBVector::BLF::MostStress\fP, \fBVector::BLF::MostSystemEvent\fP, \fBVector::BLF::MostTrigger\fP, and \fBVector::BLF::MostTxLight\fP\&. .SS "Public Types" .in +1c .ti -1c .RI "enum \fBObjectFlags\fP : uint32_t { \fBTimeTenMics\fP = 0x00000001, \fBTimeOneNans\fP = 0x00000002 }" .br .ti -1c .RI "enum \fBTimeStampStatus\fP : uint8_t { \fBOrig\fP = 0x01, \fBSwHw\fP = 0x02, \fBUser\fP = 0x10 }" .br .in -1c .SS "Public Member Functions" .in +1c .ti -1c .RI "\fBObjectHeader2\fP (const ObjectType \fBobjectType\fP)" .br .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 "uint16_t \fBcalculateHeaderSize\fP () const override" .br .ti -1c .RI "uint32_t \fBcalculateObjectSize\fP () const override" .br .in -1c Public Member Functions inherited from \fBVector::BLF::ObjectHeaderBase\fP .in +1c .ti -1c .RI "\fBObjectHeaderBase\fP (const uint16_t \fBheaderVersion\fP, const ObjectType \fBobjectType\fP)" .br .ti -1c .RI "\fBObjectHeaderBase\fP (const ObjectHeaderBase &)=default" .br .ti -1c .RI "ObjectHeaderBase & \fBoperator=\fP (const ObjectHeaderBase &)=default" .br .ti -1c .RI "\fBObjectHeaderBase\fP (ObjectHeaderBase &&)=default" .br .ti -1c .RI "ObjectHeaderBase & \fBoperator=\fP (ObjectHeaderBase &&)=default" .br .in -1c .SS "Public Attributes" .in +1c .ti -1c .RI "uint32_t \fBobjectFlags\fP {\fBObjectFlags::TimeOneNans\fP}" .br .RI "object flags " .ti -1c .RI "uint8_t \fBtimeStampStatus\fP {}" .br .RI "time stamp status " .ti -1c .RI "uint8_t \fBreservedObjectHeader\fP {0}" .br .ti -1c .RI "uint16_t \fBobjectVersion\fP {0}" .br .RI "object specific version " .ti -1c .RI "uint64_t \fBobjectTimeStamp\fP {0}" .br .RI "object timestamp " .ti -1c .RI "uint64_t \fBoriginalTimeStamp\fP {0}" .br .RI "original object timestamp " .in -1c Public Attributes inherited from \fBVector::BLF::ObjectHeaderBase\fP .in +1c .ti -1c .RI "uint32_t \fBsignature\fP {ObjectSignature}" .br .RI "signature (ObjectSignature) " .ti -1c .RI "uint16_t \fBheaderSize\fP {}" .br .RI "sizeof object header " .ti -1c .RI "uint16_t \fBheaderVersion\fP {}" .br .RI "header version (1) " .ti -1c .RI "uint32_t \fBobjectSize\fP {}" .br .RI "object size " .ti -1c .RI "ObjectType \fBobjectType\fP {ObjectType::UNKNOWN}" .br .RI "object type " .in -1c .SH "Detailed Description" .PP Object header\&. Object header\&. Version 2\&. .SH "Member Enumeration Documentation" .PP .SS "enum \fBVector::BLF::ObjectHeader2::ObjectFlags\fP : uint32_t" enumeration for objectFlags .PP \fBEnumerator\fP .in +1c .TP \f(BITimeTenMics \fP 10 micro second timestamp Object time stamp is saved as multiple of ten microseconds\&. (BL_OBJ_FLAG_TIME_TEN_MICS) .TP \f(BITimeOneNans \fP 1 nano second timestamp Object time stamp is saved in nanoseconds\&. (BL_OBJ_FLAG_TIME_ONE_NANS) .SS "enum \fBVector::BLF::ObjectHeader2::TimeStampStatus\fP : uint8_t" enumeration for timeStampStatus .PP \fBEnumerator\fP .in +1c .TP \f(BIOrig \fP 1: valid orig\&. timestamp Determines whether original timestamp member is valid (1) or not (0)\&. .TP \f(BISwHw \fP 1: sw generated ts; 0: hw Timestamp is generated by software (1) or by hardware (0)\&. .TP \f(BIUser \fP protocol specific meaning This bit has protocol specific meaning\&. .SH "Member Function Documentation" .PP .SS "uint16_t Vector::BLF::ObjectHeader2::calculateHeaderSize () const\fR [override]\fP, \fR [virtual]\fP" Calculates the headerSize .PP \fBReturns\fP .RS 4 header size .RE .PP .PP Reimplemented from \fBVector::BLF::ObjectHeaderBase\fP\&. .SS "uint32_t Vector::BLF::ObjectHeader2::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::ObjectHeaderBase\fP\&. .SS "void Vector::BLF::ObjectHeader2::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::ObjectHeaderBase\fP\&. .SS "void Vector::BLF::ObjectHeader2::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::ObjectHeaderBase\fP\&. .SH "Member Data Documentation" .PP .SS "uint32_t Vector::BLF::ObjectHeader2::objectFlags {\fBObjectFlags::TimeOneNans\fP}" .PP object flags Unit of object timestamp\&. .SS "uint64_t Vector::BLF::ObjectHeader2::objectTimeStamp {0}" .PP object timestamp Time stamp of this object in the unit specified in objectFlags\&. .SS "uint16_t Vector::BLF::ObjectHeader2::objectVersion {0}" .PP object specific version Object specific version, has to be set to 0 unless stated otherwise in the description of a specific event\&. .PP \fBNote\fP .RS 4 can be set in event class constructor .RE .PP .SS "uint64_t Vector::BLF::ObjectHeader2::originalTimeStamp {0}" .PP original object timestamp Original timestamp in the unit specified in objectFlags\&. .SS "uint8_t Vector::BLF::ObjectHeader2::reservedObjectHeader {0}" reserved .SS "uint8_t Vector::BLF::ObjectHeader2::timeStampStatus {}" .PP time stamp status Bit field\&. .SH "Author" .PP Generated automatically by Doxygen for Vector BLF from the source code\&.