.TH "Vector::BLF::VarObjectHeader" 3 "Vector BLF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
Vector::BLF::VarObjectHeader \- Extended base object header type definition with dynamic extendible objects\&.  

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

.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 "\fBVarObjectHeader\fP (\fBconst\fP ObjectType \fBobjectType\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 "\fBuint16_t\fP \fBcalculateHeaderSize\fP () \fBconst\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::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 \fBobjectFlags\fP {\fBObjectFlags::TimeOneNans\fP}"
.br
.RI "object flags "
.ti -1c
.RI "\fBuint16_t\fP \fBobjectStaticSize\fP {}"
.br
.RI "size of the static part of the object "
.ti -1c
.RI "\fBuint16_t\fP \fBobjectVersion\fP {}"
.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 
Extended base object header type definition with dynamic extendible objects\&. 
.SH "Member Enumeration Documentation"
.PP 
.SS "\fBenum\fP \fBVector::BLF::VarObjectHeader::ObjectFlags\fP : \fBuint32_t\fP"
enumeration for objectFlags 
.PP
\fBEnumerator\fP
.in +1c
.TP
\fB\fITimeTenMics \fP\fP
10 micro second timestamp Object time stamp is saved as multiple of ten microseconds\&. (BL_OBJ_FLAG_TIME_TEN_MICS) 
.TP
\fB\fITimeOneNans \fP\fP
1 nano second timestamp Object time stamp is saved in nanoseconds\&. (BL_OBJ_FLAG_TIME_ONE_NANS) 
.SH "Member Function Documentation"
.PP 
.SS "\fBuint16_t\fP Vector::BLF::VarObjectHeader::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 "\fBuint32_t\fP Vector::BLF::VarObjectHeader::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 "\fBvoid\fP Vector::BLF::VarObjectHeader::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 "\fBvoid\fP Vector::BLF::VarObjectHeader::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 "\fBuint32_t\fP Vector::BLF::VarObjectHeader::objectFlags {\fBObjectFlags::TimeOneNans\fP}"

.PP
object flags Unit of object timestamp\&. 
.SS "\fBuint64_t\fP Vector::BLF::VarObjectHeader::objectTimeStamp {}"

.PP
object timestamp Time stamp of this object in the unit specified in objectFlags\&. 
.SS "\fBuint16_t\fP Vector::BLF::VarObjectHeader::objectVersion {}"

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

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