.TH "Vector::BLF::ObjectHeader" 3 "Vector BLF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
Vector::BLF::ObjectHeader \- Object header\&.  

.SH SYNOPSIS
.br
.PP
.PP
\fR#include <ObjectHeader\&.h>\fP
.PP
Inherits \fBVector::BLF::ObjectHeaderBase\fP\&.
.PP
Inherited by \fBVector::BLF::A429BusStatistic\fP, \fBVector::BLF::A429Error\fP, \fBVector::BLF::A429Message\fP, \fBVector::BLF::A429Status\fP, \fBVector::BLF::AfdxBusStatistic\fP, \fBVector::BLF::AfdxErrorEvent\fP, \fBVector::BLF::AfdxFrame\fP, \fBVector::BLF::AfdxStatistic\fP, \fBVector::BLF::AfdxStatus\fP, \fBVector::BLF::AppText\fP, \fBVector::BLF::AppTrigger\fP, \fBVector::BLF::AttributeEvent\fP, \fBVector::BLF::CanDriverError\fP, \fBVector::BLF::CanDriverErrorExt\fP, \fBVector::BLF::CanDriverHwSync\fP, \fBVector::BLF::CanDriverStatistic\fP, \fBVector::BLF::CanErrorFrame\fP, \fBVector::BLF::CanErrorFrameExt\fP, \fBVector::BLF::CanFdErrorFrame64\fP, \fBVector::BLF::CanFdMessage\fP, \fBVector::BLF::CanFdMessage64\fP, \fBVector::BLF::CanMessage\fP, \fBVector::BLF::CanMessage2\fP, \fBVector::BLF::CanOverloadFrame\fP, \fBVector::BLF::CanSettingChanged\fP, \fBVector::BLF::DataLostBegin\fP, \fBVector::BLF::DataLostEnd\fP, \fBVector::BLF::DiagRequestInterpretation\fP, \fBVector::BLF::DistributedObjectMember\fP, \fBVector::BLF::DriverOverrun\fP, \fBVector::BLF::EnvironmentVariable\fP, \fBVector::BLF::EthernetErrorEx\fP, \fBVector::BLF::EthernetErrorForwarded\fP, \fBVector::BLF::EthernetFrame\fP, \fBVector::BLF::EthernetFrameEx\fP, \fBVector::BLF::EthernetFrameForwarded\fP, \fBVector::BLF::EthernetRxError\fP, \fBVector::BLF::EthernetStatistic\fP, \fBVector::BLF::EthernetStatus\fP, \fBVector::BLF::EventComment\fP, \fBVector::BLF::FlexRayData\fP, \fBVector::BLF::FlexRayStatusEvent\fP, \fBVector::BLF::FlexRaySync\fP, \fBVector::BLF::FlexRayV6Message\fP, \fBVector::BLF::FlexRayV6StartCycleEvent\fP, \fBVector::BLF::FlexRayVFrError\fP, \fBVector::BLF::FlexRayVFrReceiveMsg\fP, \fBVector::BLF::FlexRayVFrReceiveMsgEx\fP, \fBVector::BLF::FlexRayVFrStartCycle\fP, \fBVector::BLF::FlexRayVFrStatus\fP, \fBVector::BLF::FunctionBus\fP, \fBVector::BLF::GlobalMarker\fP, \fBVector::BLF::GpsEvent\fP, \fBVector::BLF::J1708Message\fP, \fBVector::BLF::KLineStatusEvent\fP, \fBVector::BLF::LinBaudrateEvent\fP, \fBVector::BLF::LinChecksumInfo\fP, \fBVector::BLF::LinCrcError\fP, \fBVector::BLF::LinCrcError2\fP, \fBVector::BLF::LinDisturbanceEvent\fP, \fBVector::BLF::LinDlcInfo\fP, \fBVector::BLF::LinLongDomSignalEvent\fP, \fBVector::BLF::LinLongDomSignalEvent2\fP, \fBVector::BLF::LinMessage\fP, \fBVector::BLF::LinMessage2\fP, \fBVector::BLF::LinReceiveError\fP, \fBVector::BLF::LinReceiveError2\fP, \fBVector::BLF::LinSchedulerModeChange\fP, \fBVector::BLF::LinSendError\fP, \fBVector::BLF::LinSendError2\fP, \fBVector::BLF::LinShortOrSlowResponse\fP, \fBVector::BLF::LinShortOrSlowResponse2\fP, \fBVector::BLF::LinSlaveTimeout\fP, \fBVector::BLF::LinSleepModeEvent\fP, \fBVector::BLF::LinSpikeEvent\fP, \fBVector::BLF::LinSpikeEvent2\fP, \fBVector::BLF::LinStatisticEvent\fP, \fBVector::BLF::LinSyncError\fP, \fBVector::BLF::LinSyncError2\fP, \fBVector::BLF::LinUnexpectedWakeup\fP, \fBVector::BLF::LinWakeupEvent\fP, \fBVector::BLF::LinWakeupEvent2\fP, \fBVector::BLF::MostCtrl\fP, \fBVector::BLF::MostLightLock\fP, \fBVector::BLF::MostPkt\fP, \fBVector::BLF::MostSpy\fP, \fBVector::BLF::MostStatistic\fP, \fBVector::BLF::RealtimeClock\fP, \fBVector::BLF::RestorePointContainer\fP, \fBVector::BLF::SerialEvent\fP, \fBVector::BLF::SystemVariable\fP, \fBVector::BLF::TestStructure\fP, \fBVector::BLF::TriggerCondition\fP, \fBVector::BLF::WaterMarkEvent\fP, \fBVector::BLF::WlanFrame\fP, and \fBVector::BLF::WlanStatistic\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 "\fBObjectHeader\fP (\fBconst\fP ObjectType \fBobjectType\fP, \fBconst\fP \fBuint16_t\fP \fBobjectVersion\fP=0)"
.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 \fBclientIndex\fP {}"
.br
.RI "client index of send node "
.ti -1c
.RI "\fBuint16_t\fP \fBobjectVersion\fP {0}"
.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 
Object header\&. 

Object header\&. Version 1\&. 
.SH "Member Enumeration Documentation"
.PP 
.SS "\fBenum\fP \fBVector::BLF::ObjectHeader::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::ObjectHeader::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::ObjectHeader::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\&.
.PP
Reimplemented in \fBVector::BLF::RealtimeClock\fP, \fBVector::BLF::RestorePointContainer\fP, \fBVector::BLF::SerialEvent\fP, \fBVector::BLF::SystemVariable\fP, \fBVector::BLF::TestStructure\fP, \fBVector::BLF::TriggerCondition\fP, \fBVector::BLF::WaterMarkEvent\fP, \fBVector::BLF::WlanFrame\fP, and \fBVector::BLF::WlanStatistic\fP\&.
.SS "\fBvoid\fP Vector::BLF::ObjectHeader::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\&.
.PP
Reimplemented in \fBVector::BLF::RealtimeClock\fP, \fBVector::BLF::RestorePointContainer\fP, \fBVector::BLF::SerialEvent\fP, \fBVector::BLF::SystemVariable\fP, \fBVector::BLF::TestStructure\fP, \fBVector::BLF::TriggerCondition\fP, \fBVector::BLF::WaterMarkEvent\fP, \fBVector::BLF::WlanFrame\fP, and \fBVector::BLF::WlanStatistic\fP\&.
.SS "\fBvoid\fP Vector::BLF::ObjectHeader::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\&.
.PP
Reimplemented in \fBVector::BLF::RealtimeClock\fP, \fBVector::BLF::RestorePointContainer\fP, \fBVector::BLF::SerialEvent\fP, \fBVector::BLF::SystemVariable\fP, \fBVector::BLF::TestStructure\fP, \fBVector::BLF::TriggerCondition\fP, \fBVector::BLF::WaterMarkEvent\fP, \fBVector::BLF::WlanFrame\fP, and \fBVector::BLF::WlanStatistic\fP\&.
.SH "Member Data Documentation"
.PP 
.SS "\fBuint32_t\fP Vector::BLF::ObjectHeader::objectFlags {\fBObjectFlags::TimeOneNans\fP}"

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

.PP
object timestamp Time stamp of this object in the unit specified in objectFlags\&. 
.SS "\fBuint16_t\fP Vector::BLF::ObjectHeader::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


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