VECTOR_BLF_MOSTDATALOST(3)

πŸ“¦ version 2.4.2, in arch rolling

πŸ’… Vector::BLF::MostDataLost(3) β€” MOST_DATALOST πŸ’…

from the Library Functions Manual β€” yes bestie, we are literally in the library-functions manual 🫢

🌸 NAME 🌸

Vector::BLF::MostDataLost β€” MOST_DATALOST.

✨ SYNOPSIS ✨

#include <MostDataLost.h>

Inherits Vector::BLF::ObjectHeader2.

πŸ’– Public Member Functions

  • void read (AbstractFile &is) override β€” the read override, slaying input streams.
  • void write (AbstractFile &os) override β€” the write override, doing output-stream business.
  • uint32_t calculateObjectSize () const override β€” the object-size calculator override, living its const life.

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

  • ObjectHeader2 (const ObjectType objectType) β€” constructor energy.
  • void read (AbstractFile &is) override β€” inherited read override.
  • void write (AbstractFile &os) override β€” inherited write override.
  • uint16_t calculateHeaderSize () const override β€” inherited header-size calculator.
  • uint32_t calculateObjectSize () const override β€” inherited object-size calculator.

🧚 Public Member Functions inherited from Vector::BLF::ObjectHeaderBase

  • ObjectHeaderBase (const uint16_t headerVersion, const ObjectType objectType) β€” constructor with headerVersion and objectType.
  • ObjectHeaderBase (const ObjectHeaderBase &)=default β€” copy constructor, defaulted.
  • ObjectHeaderBase & operator= (const ObjectHeaderBase &)=default β€” copy assignment, defaulted.
  • ObjectHeaderBase (ObjectHeaderBase &&)=default β€” move constructor, defaulted.
  • ObjectHeaderBase & operator= (ObjectHeaderBase &&)=default β€” move assignment, defaulted.

πŸ‘‘ Public Attributes

  • uint16_t channel {} β€” application channel.
  • uint16_t reservedMostDataLost {} β€” reserved.
  • uint32_t info {} β€” info about data loss.
  • uint32_t lostMsgsCtrl {} β€” number of lost messages on Control channel.
  • uint32_t lostMsgsAsync {} β€” number of lost messages on Packet Data Channel channel.
  • uint64_t lastGoodTimeStampNs {} β€” absolute time in nano-seconds.
  • uint64_t nextGoodTimeStampNs {} β€” absolute time in nano-seconds.

πŸŽ€ Public Attributes inherited from Vector::BLF::ObjectHeader2

  • uint32_t objectFlags {ObjectFlags::TimeOneNans} β€” object flags.
  • uint8_t timeStampStatus {} β€” time stamp status.
  • uint8_t reservedObjectHeader {0} β€” reserved object-header value.
  • uint16_t objectVersion {0} β€” object specific version.
  • uint64_t objectTimeStamp {0} β€” object timestamp.
  • uint64_t originalTimeStamp {0} β€” original 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::ObjectHeader2

  • enum ObjectFlags : uint32_t { TimeTenMics = 0x00000001, TimeOneNans = 0x00000002 } β€” the ObjectFlags enum, exactly like that.
  • enum TimeStampStatus : uint8_t { Orig = 0x01, SwHw = 0x02, User = 0x10 } β€” the TimeStampStatus enum, exactly like that.

πŸ¦‹ Detailed Description πŸ¦‹

MOST_DATALOST is the whole vibe here. It indicates loss of data. (Number of lost messages and start and end time stamp of data loss.) πŸ˜­πŸ’”

πŸ’– Member Function Documentation πŸ’–

πŸ’… uint32_t Vector::BLF::MostDataLost::calculateObjectSize () const [override], [virtual]

Calculates the objectSize.

Returns: object size.

Reimplemented from Vector::BLF::ObjectHeaderBase.

πŸ’… void Vector::BLF::MostDataLost::read (AbstractFile & is) [override], [virtual]

Read the data of this object.

Parameters: is β€” input stream.

Reimplemented from Vector::BLF::ObjectHeaderBase.

πŸ’… void Vector::BLF::MostDataLost::write (AbstractFile & os) [override], [virtual]

Write the data of this object.

Parameters: os β€” output stream.

Reimplemented from Vector::BLF::ObjectHeaderBase.

πŸŽ€ Member Data Documentation πŸŽ€

🌸 uint16_t Vector::BLF::MostDataLost::channel {}

Application channel β€” the docs also call it β€œApplication channel,” so yes, it said it twice, and we respect the duplication πŸ’…

🌸 uint32_t Vector::BLF::MostDataLost::info {}

Info about data loss β€” Data loss information. The bits are giving very specific:

  • Bit0: 1: data loss on control channel (spy)
  • Bit1: 1: data loss on control channel (node)
  • Bit2: 1: data loss on asynchronous channel (spy)
  • Bit3: 1: data loss on asynchronous channel (node)
  • Bit4: 1: data loss on synchronous channel
  • Bit5: 1: data loss since driver queue full

🌸 uint64_t Vector::BLF::MostDataLost::lastGoodTimeStampNs {}

Absolute time in nano-seconds.

🌸 uint32_t Vector::BLF::MostDataLost::lostMsgsAsync {}

Number of lost messages on Packet Data Channel channel β€” keeping the β€œchannel channel” exactly as the docs handed it over, no notes πŸ”₯

🌸 uint32_t Vector::BLF::MostDataLost::lostMsgsCtrl {}

Number of lost messages on Control channel.

🌸 uint64_t Vector::BLF::MostDataLost::nextGoodTimeStampNs {}

Absolute time in nano-seconds.

🌸 uint16_t Vector::BLF::MostDataLost::reservedMostDataLost {}

Reserved.

πŸ‘‘ Author πŸ‘‘

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


Cute sign-off: source/version is Vector BLF, and the footer date slot is literally not showing a date in what I got β€” so I’m not inventing one, periodt πŸ’€πŸ’–

πŸ“¦ where this page comes from