Vector::BL...tContainer(3)

πŸ“¦ version 2.4.2, in arch rolling

πŸŽ€ NAME πŸŽ€

Vector::BLF::RestorePointContainer β€” UNKNOWN_115.

Okay so this page comes from the Library Functions Manual, bestie, and the header title vibe is Vector::BL...tContainer(3). Yes, the truncation is giving mysterious main-character energy, but the full class name is right up there ☝️ πŸ’…


✨ SYNOPSIS ✨

#include <RestorePointContainer.h>

Inherits Vector::BLF::ObjectHeader.

🌸 Public Member Functions 🌸

void read (AbstractFile &is) override
void write (AbstractFile &os) override
uint32_t calculateObjectSize () const override

πŸ’œ Public Member Functions inherited from Vector::BLF::ObjectHeader πŸ’œ

ObjectHeader (const ObjectType objectType, const uint16_t objectVersion=0)
uint16_t calculateHeaderSize () const override

πŸ¦‹ Public Member Functions inherited from Vector::BLF::ObjectHeaderBase πŸ¦‹

ObjectHeaderBase (const uint16_t headerVersion, const ObjectType objectType)
ObjectHeaderBase (const ObjectHeaderBase &)=default
ObjectHeaderBase & operator= (const ObjectHeaderBase &)=default
ObjectHeaderBase (ObjectHeaderBase &&)=default
ObjectHeaderBase & operator= (ObjectHeaderBase &&)=default

πŸ“ Public Attributes πŸ“

std::array< uint8_t, 14 > reservedRestorePointContainer {}
uint16_t dataLength {}
std::vector< uint8_t > data {}

🌈 Public Attributes inherited from Vector::BLF::ObjectHeader 🌈

  • uint32_t objectFlags {ObjectFlags::TimeOneNans} β€” object flags
  • uint16_t clientIndex {} β€” client index of send node
  • uint16_t objectVersion {0} β€” object specific version
  • uint64_t objectTimeStamp {} β€” 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

πŸŽ€ Additional Inherited Members πŸŽ€

πŸ’« Public Types inherited from Vector::BLF::ObjectHeader πŸ’«

enum ObjectFlags : uint32_t { TimeTenMics = 0x00000001, TimeOneNans =
    0x00000002 }

🌸 Detailed Description 🌸

UNKNOWN_115.

These objects store a contiguous block of data containing the Restore Points, similar to what a LogContainer does for Log data. That's the whole vibe, fr fr.

The default dataLength is 2000, which results in an objectSize of 2048. Math is math, bestie ✨

Note: This class is based on observations, as there is no public documentation available. There are undocumented API functions for RestorePoint handling. And this seems like it. πŸ‘€

πŸ› οΈ Member Function Documentation πŸ› οΈ

uint32_t Vector::BLF::RestorePointContainer::calculateObjectSize () const

[override], [virtual]

Calculates the objectSize.

Returns: object size.

Reimplemented from: Vector::BLF::ObjectHeader.

void Vector::BLF::RestorePointContainer::read (AbstractFile & is)

[override], [virtual]

Read the data of this object.

Parameters: is input stream.

Reimplemented from: Vector::BLF::ObjectHeader.

void Vector::BLF::RestorePointContainer::write (AbstractFile & os)

[override], [virtual]

Write the data of this object.

Parameters: os output stream.

Reimplemented from: Vector::BLF::ObjectHeader.


🧸 Member Data Documentation 🧸

std::vector<uint8_t> Vector::BLF::RestorePointContainer::data {}

restore point data.

uint16_t Vector::BLF::RestorePointContainer::dataLength {}

restore point data size.

std::array<uint8_t, 14> Vector::BLF::RestorePointContainer::reservedRestorePointContainer {}

reserved.


πŸ‘‘ Author πŸ‘‘

Generated automatically by Doxygen for Vector BLF from the source code.


Cute sign-off: source/version is Vector BLF, and the original footer didn't show a date, so date: not listed, bestie. Page title energy: Vector::BL...tContainer(3). Bye, go read those restore points πŸ’–βœ¨

πŸ“¦ where this page comes from