VECTOR_BLF_OBJECTHEADERBASE(3)

📦 version 2.4.2, in arch rolling

💖 Vector::BLF::ObjectHeaderBase(3) 💖

Manual: Library Functions Manual — yes bestie, this is the manual page for Vector::BLF::ObjectHeaderBase(3), and we're doing it with full group-chat energy.

✨ NAME ✨

Vector::BLF::ObjectHeaderBase — base object header type definition. It's giving "blueprint energy" for object headers, periodt.

🌸 SYNOPSIS 🌸

#include <ObjectHeaderBase.h>

🫶 Inherited by

  • Vector::BLF::LogContainer
  • Vector::BLF::ObjectHeader
  • Vector::BLF::ObjectHeader2
  • Vector::BLF::VarObjectHeader

💅 Public Member Functions

  • ObjectHeaderBase (const uint16_t headerVersion, const ObjectType objectType) — constructor with headerVersion and objectType.
  • ObjectHeaderBase (const ObjectHeaderBase &)=default — defaulted copy-style constructor, slay.
  • ObjectHeaderBase & operator= (const ObjectHeaderBase &)=default — defaulted copy-assignment-ish operator.
  • ObjectHeaderBase (ObjectHeaderBase &&)=default — defaulted move-style constructor.
  • ObjectHeaderBase & operator= (ObjectHeaderBase &&)=default — defaulted move-assignment-ish operator.
  • virtual void read (AbstractFile &is) — reads from is.
  • virtual void write (AbstractFile &os) — writes to os.
  • virtual uint16_t calculateHeaderSize () const — calculates the header size.
  • virtual uint32_t calculateObjectSize () const — calculates the object size.

🎀 Public Attributes

  • 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 🦋

Base object header type definition.

Object header base structure.

🔥 Member Function Documentation 🔥

🧮 uint16_t Vector::BLF::ObjectHeaderBase::calculateHeaderSize () const [virtual]

Calculates the headerSize. Literally its whole job, no cap.

  • Returns: header size
  • Reimplemented in: Vector::BLF::ObjectHeader2, Vector::BLF::ObjectHeader, and Vector::BLF::VarObjectHeader.

📏 uint32_t Vector::BLF::ObjectHeaderBase::calculateObjectSize () const [virtual]

Calculates the objectSize. Big "math girlie" energy.

  • Returns: object size
  • Reimplemented in: the whole reimplemented-in roll call, and bestie it is LONG: Vector::BLF::A429BusStatistic, Vector::BLF::A429Error, Vector::BLF::A429Message, Vector::BLF::A429Status, Vector::BLF::AfdxBusStatistic, Vector::BLF::AfdxErrorEvent, Vector::BLF::AfdxFrame, Vector::BLF::AfdxStatistic, Vector::BLF::AfdxStatus, Vector::BLF::AppText, Vector::BLF::AppTrigger, Vector::BLF::AttributeEvent, Vector::BLF::CanDriverError, Vector::BLF::CanDriverErrorExt, Vector::BLF::CanDriverHwSync, Vector::BLF::CanDriverStatistic, Vector::BLF::CanErrorFrame, Vector::BLF::CanErrorFrameExt, Vector::BLF::CanFdErrorFrame64, Vector::BLF::CanFdMessage64, Vector::BLF::CanFdMessage, Vector::BLF::CanMessage2, Vector::BLF::CanMessage, Vector::BLF::CanOverloadFrame, Vector::BLF::CanSettingChanged, Vector::BLF::DataLostBegin, Vector::BLF::DataLostEnd, Vector::BLF::DiagRequestInterpretation, Vector::BLF::DistributedObjectMember, Vector::BLF::DriverOverrun, Vector::BLF::EnvironmentVariable, Vector::BLF::EthernetErrorEx, Vector::BLF::EthernetErrorForwarded, Vector::BLF::EthernetFrame, Vector::BLF::EthernetFrameEx, Vector::BLF::EthernetFrameForwarded, Vector::BLF::EthernetRxError, Vector::BLF::EthernetStatistic, Vector::BLF::EthernetStatus, Vector::BLF::EventComment, Vector::BLF::FlexRayData, Vector::BLF::FlexRayStatusEvent, Vector::BLF::FlexRaySync, Vector::BLF::FlexRayV6Message, Vector::BLF::FlexRayV6StartCycleEvent, Vector::BLF::FlexRayVFrError, Vector::BLF::FlexRayVFrReceiveMsg, Vector::BLF::FlexRayVFrReceiveMsgEx, Vector::BLF::FlexRayVFrStartCycle, Vector::BLF::FlexRayVFrStatus, Vector::BLF::FunctionBus, Vector::BLF::GlobalMarker, Vector::BLF::GpsEvent, Vector::BLF::J1708Message, Vector::BLF::KLineStatusEvent, Vector::BLF::LinBaudrateEvent, Vector::BLF::LinChecksumInfo, Vector::BLF::LinCrcError2, Vector::BLF::LinCrcError, Vector::BLF::LinDisturbanceEvent, Vector::BLF::LinDlcInfo, Vector::BLF::LinLongDomSignalEvent2, Vector::BLF::LinLongDomSignalEvent, Vector::BLF::LinMessage2, Vector::BLF::LinMessage, Vector::BLF::LinReceiveError2, Vector::BLF::LinReceiveError, Vector::BLF::LinSchedulerModeChange, Vector::BLF::LinSendError2, Vector::BLF::LinSendError, Vector::BLF::LinShortOrSlowResponse2, Vector::BLF::LinShortOrSlowResponse, Vector::BLF::LinSlaveTimeout, Vector::BLF::LinSleepModeEvent, Vector::BLF::LinSpikeEvent2, Vector::BLF::LinSpikeEvent, Vector::BLF::LinStatisticEvent, Vector::BLF::LinSyncError2, Vector::BLF::LinSyncError, Vector::BLF::LinUnexpectedWakeup, Vector::BLF::LinWakeupEvent2, Vector::BLF::LinWakeupEvent, Vector::BLF::LogContainer, 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::MostCtrl, Vector::BLF::MostDataLost, Vector::BLF::MostEcl, Vector::BLF::MostEthernetPkt, Vector::BLF::MostEthernetPktFragment, Vector::BLF::MostGenReg, Vector::BLF::MostHwMode, Vector::BLF::MostLightLock, Vector::BLF::MostNetState, Vector::BLF::MostPkt2, Vector::BLF::MostPkt, Vector::BLF::MostReg, Vector::BLF::MostSpy, Vector::BLF::MostStatistic, Vector::BLF::MostStatisticEx, Vector::BLF::MostStress, Vector::BLF::MostSystemEvent, Vector::BLF::MostTrigger, Vector::BLF::MostTxLight, Vector::BLF::ObjectHeader2, Vector::BLF::ObjectHeader, Vector::BLF::RealtimeClock, Vector::BLF::RestorePointContainer, Vector::BLF::SerialEvent, Vector::BLF::SystemVariable, Vector::BLF::TestStructure, Vector::BLF::TriggerCondition, Vector::BLF::VarObjectHeader, Vector::BLF::WaterMarkEvent, Vector::BLF::WlanFrame, Vector::BLF::WlanStatistic.

📥 void Vector::BLF::ObjectHeaderBase::read (AbstractFile & is) [virtual]

Read the data of this object. Come get y'all juice.

  • Parameters: is input stream
  • Reimplemented in: the same iconic reimplemented-in lineup, every single one: Vector::BLF::A429BusStatistic, Vector::BLF::A429Error, Vector::BLF::A429Message, Vector::BLF::A429Status, Vector::BLF::AfdxBusStatistic, Vector::BLF::AfdxErrorEvent, Vector::BLF::AfdxFrame, Vector::BLF::AfdxStatistic, Vector::BLF::AfdxStatus, Vector::BLF::AppText, Vector::BLF::AppTrigger, Vector::BLF::AttributeEvent, Vector::BLF::CanDriverError, Vector::BLF::CanDriverErrorExt, Vector::BLF::CanDriverHwSync, Vector::BLF::CanDriverStatistic, Vector::BLF::CanErrorFrame, Vector::BLF::CanErrorFrameExt, Vector::BLF::CanFdErrorFrame64, Vector::BLF::CanFdMessage64, Vector::BLF::CanFdMessage, Vector::BLF::CanMessage2, Vector::BLF::CanMessage, Vector::BLF::CanOverloadFrame, Vector::BLF::CanSettingChanged, Vector::BLF::DataLostBegin, Vector::BLF::DataLostEnd, Vector::BLF::DiagRequestInterpretation, Vector::BLF::DistributedObjectMember, Vector::BLF::DriverOverrun, Vector::BLF::EnvironmentVariable, Vector::BLF::EthernetErrorEx, Vector::BLF::EthernetErrorForwarded, Vector::BLF::EthernetFrame, Vector::BLF::EthernetFrameEx, Vector::BLF::EthernetFrameForwarded, Vector::BLF::EthernetRxError, Vector::BLF::EthernetStatistic, Vector::BLF::EthernetStatus, Vector::BLF::EventComment, Vector::BLF::FlexRayData, Vector::BLF::FlexRayStatusEvent, Vector::BLF::FlexRaySync, Vector::BLF::FlexRayV6Message, Vector::BLF::FlexRayV6StartCycleEvent, Vector::BLF::FlexRayVFrError, Vector::BLF::FlexRayVFrReceiveMsg, Vector::BLF::FlexRayVFrReceiveMsgEx, Vector::BLF::FlexRayVFrStartCycle, Vector::BLF::FlexRayVFrStatus, Vector::BLF::FunctionBus, Vector::BLF::GlobalMarker, Vector::BLF::GpsEvent, Vector::BLF::J1708Message, Vector::BLF::KLineStatusEvent, Vector::BLF::LinBaudrateEvent, Vector::BLF::LinChecksumInfo, Vector::BLF::LinCrcError2, Vector::BLF::LinCrcError, Vector::BLF::LinDisturbanceEvent, Vector::BLF::LinDlcInfo, Vector::BLF::LinLongDomSignalEvent2, Vector::BLF::LinLongDomSignalEvent, Vector::BLF::LinMessage2, Vector::BLF::LinMessage, Vector::BLF::LinReceiveError2, Vector::BLF::LinReceiveError, Vector::BLF::LinSchedulerModeChange, Vector::BLF::LinSendError2, Vector::BLF::LinSendError, Vector::BLF::LinShortOrSlowResponse2, Vector::BLF::LinShortOrSlowResponse, Vector::BLF::LinSlaveTimeout, Vector::BLF::LinSleepModeEvent, Vector::BLF::LinSpikeEvent2, Vector::BLF::LinSpikeEvent, Vector::BLF::LinStatisticEvent, Vector::BLF::LinSyncError2, Vector::BLF::LinSyncError, Vector::BLF::LinUnexpectedWakeup, Vector::BLF::LinWakeupEvent2, Vector::BLF::LinWakeupEvent, Vector::BLF::LogContainer, 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::MostCtrl, Vector::BLF::MostDataLost, Vector::BLF::MostEcl, Vector::BLF::MostEthernetPkt, Vector::BLF::MostEthernetPktFragment, Vector::BLF::MostGenReg, Vector::BLF::MostHwMode, Vector::BLF::MostLightLock, Vector::BLF::MostNetState, Vector::BLF::MostPkt2, Vector::BLF::MostPkt, Vector::BLF::MostReg, Vector::BLF::MostSpy, Vector::BLF::MostStatistic, Vector::BLF::MostStatisticEx, Vector::BLF::MostStress, Vector::BLF::MostSystemEvent, Vector::BLF::MostTrigger, Vector::BLF::MostTxLight, Vector::BLF::ObjectHeader2, Vector::BLF::ObjectHeader, Vector::BLF::RealtimeClock, Vector::BLF::RestorePointContainer, Vector::BLF::SerialEvent, Vector::BLF::SystemVariable, Vector::BLF::TestStructure, Vector::BLF::TriggerCondition, Vector::BLF::VarObjectHeader, Vector::BLF::WaterMarkEvent, Vector::BLF::WlanFrame, Vector::BLF::WlanStatistic.

📤 void Vector::BLF::ObjectHeaderBase::write (AbstractFile & os) [virtual]

Write the data of this object. Sending it, bestie.

  • Parameters: os output stream

✨ Reimplemented in ✨

okay so this one is the overachiever of the family — basically every single object class in the whole library reimplements it. no cap, here's the full squad, exactly as listed:

  • Vector::BLF::A429BusStatistic
  • Vector::BLF::A429Error
  • Vector::BLF::A429Message
  • Vector::BLF::A429Status
  • Vector::BLF::AfdxBusStatistic
  • Vector::BLF::AfdxErrorEvent
  • Vector::BLF::AfdxFrame
  • Vector::BLF::AfdxStatistic
  • Vector::BLF::AfdxStatus
  • Vector::BLF::AppText
  • Vector::BLF::AppTrigger
  • Vector::BLF::AttributeEvent
  • Vector::BLF::CanDriverError
  • Vector::BLF::CanDriverErrorExt
  • Vector::BLF::CanDriverHwSync
  • Vector::BLF::CanDriverStatistic
  • Vector::BLF::CanErrorFrame
  • Vector::BLF::CanErrorFrameExt
  • Vector::BLF::CanFdErrorFrame64
  • Vector::BLF::CanFdMessage64
  • Vector::BLF::CanFdMessage
  • Vector::BLF::CanMessage2
  • Vector::BLF::CanMessage
  • Vector::BLF::CanOverloadFrame
  • Vector::BLF::CanSettingChanged
  • Vector::BLF::DataLostBegin
  • Vector::BLF::DataLostEnd
  • Vector::BLF::DiagRequestInterpretation
  • Vector::BLF::DistributedObjectMember
  • Vector::BLF::DriverOverrun
  • Vector::BLF::EnvironmentVariable
  • Vector::BLF::EthernetErrorEx
  • Vector::BLF::EthernetErrorForwarded
  • Vector::BLF::EthernetFrame
  • Vector::BLF::EthernetFrameEx
  • Vector::BLF::EthernetFrameForwarded
  • Vector::BLF::EthernetRxError
  • Vector::BLF::EthernetStatistic
  • Vector::BLF::EthernetStatus
  • Vector::BLF::EventComment
  • Vector::BLF::FlexRayData
  • Vector::BLF::FlexRayStatusEvent
  • Vector::BLF::FlexRaySync
  • Vector::BLF::FlexRayV6Message
  • Vector::BLF::FlexRayV6StartCycleEvent
  • Vector::BLF::FlexRayVFrError
  • Vector::BLF::FlexRayVFrReceiveMsg
  • Vector::BLF::FlexRayVFrReceiveMsgEx
  • Vector::BLF::FlexRayVFrStartCycle
  • Vector::BLF::FlexRayVFrStatus
  • Vector::BLF::FunctionBus
  • Vector::BLF::GlobalMarker
  • Vector::BLF::GpsEvent
  • Vector::BLF::J1708Message
  • Vector::BLF::KLineStatusEvent
  • Vector::BLF::LinBaudrateEvent
  • Vector::BLF::LinChecksumInfo
  • Vector::BLF::LinCrcError2
  • Vector::BLF::LinCrcError
  • Vector::BLF::LinDisturbanceEvent
  • Vector::BLF::LinDlcInfo
  • Vector::BLF::LinLongDomSignalEvent2
  • Vector::BLF::LinLongDomSignalEvent
  • Vector::BLF::LinMessage2
  • Vector::BLF::LinMessage
  • Vector::BLF::LinReceiveError2
  • Vector::BLF::LinReceiveError
  • Vector::BLF::LinSchedulerModeChange
  • Vector::BLF::LinSendError2
  • Vector::BLF::LinSendError
  • Vector::BLF::LinShortOrSlowResponse2
  • Vector::BLF::LinShortOrSlowResponse
  • Vector::BLF::LinSlaveTimeout
  • Vector::BLF::LinSleepModeEvent
  • Vector::BLF::LinSpikeEvent2
  • Vector::BLF::LinSpikeEvent
  • Vector::BLF::LinStatisticEvent
  • Vector::BLF::LinSyncError2
  • Vector::BLF::LinSyncError
  • Vector::BLF::LinUnexpectedWakeup
  • Vector::BLF::LinWakeupEvent2
  • Vector::BLF::LinWakeupEvent
  • Vector::BLF::LogContainer
  • 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::MostCtrl
  • Vector::BLF::MostDataLost
  • Vector::BLF::MostEcl
  • Vector::BLF::MostEthernetPkt
  • Vector::BLF::MostEthernetPktFragment
  • Vector::BLF::MostGenReg
  • Vector::BLF::MostHwMode
  • Vector::BLF::MostLightLock
  • Vector::BLF::MostNetState
  • Vector::BLF::MostPkt2
  • Vector::BLF::MostPkt
  • Vector::BLF::MostReg
  • Vector::BLF::MostSpy
  • Vector::BLF::MostStatistic
  • Vector::BLF::MostStatisticEx
  • Vector::BLF::MostStress
  • Vector::BLF::MostSystemEvent
  • Vector::BLF::MostTrigger
  • Vector::BLF::MostTxLight
  • Vector::BLF::ObjectHeader2
  • Vector::BLF::ObjectHeader
  • Vector::BLF::RealtimeClock
  • Vector::BLF::RestorePointContainer
  • Vector::BLF::SerialEvent
  • Vector::BLF::SystemVariable
  • Vector::BLF::TestStructure
  • Vector::BLF::TriggerCondition
  • Vector::BLF::VarObjectHeader
  • Vector::BLF::WaterMarkEvent
  • Vector::BLF::WlanFrame
  • Vector::BLF::WlanStatistic

like… everybody. it's giving "everyone showed up to the party" 💅

🫶 Member Data Documentation 🫶

🌸 headerSize — the sizeof object header moment

uint16_t Vector::BLF::ObjectHeaderBase::headerSize {}

size of header, bestie. it's the size of the header in bytes, and you set this member to sizeof(ObjectHeader) or sizeof(ObjectHeader2), depending on which object header type your object is using. pick the right one, okay? 😭

🎀 headerVersion — header version (1)

uint16_t Vector::BLF::ObjectHeaderBase::headerVersion {}

this is the version number of the object header, and yes the default-ish value shown is 1:

  • set this member to 1 if the object has a member of type ObjectHeader. ✨
  • set this member to 2 if the object has a member of type ObjectHeader2. 💖
Note: is set in ObjectHeader/ObjectHeader2 — so like, it gets handled for you over there, you're not out here doing it manually. 🙈

🦋 objectSize — object size

uint32_t Vector::BLF::ObjectHeaderBase::objectSize {}

the object size, in bytes. that's it, that's the vibe. 📏

👑 objectType — object type

ObjectType Vector::BLF::ObjectHeaderBase::objectType {ObjectType::UNKNOWN}

the object type, defaulting to ObjectType::UNKNOWN.

Note: is set in each event class constructor — so each event class handles its own, no cap. 🔥

⭐ signature — signature (ObjectSignature)

uint32_t Vector::BLF::ObjectHeaderBase::signature {ObjectSignature}

the object signature, and here's the rule, periodt: it must be ObjectSignature. no other value. none. don't try it. 💀

🌈 Author 🌈

Generated automatically by Doxygen for Vector BLF from the source code. yeah, bestie didn't hand-write this one, the robots did it for her 🤖✨

and that's a wrap on the whole page! 🎉 source/version says Vector BLF, and the footer's tagging this one as Vector::BL...tHeaderBase(3) — generated, documented, iconic, done. mwah 💋💖

📦 where this page comes from