libstp
Robotics library for Botball
Loading...
Searching...
No Matches
libstp::hal::platform::ProbeResult Struct Reference

#include <Platform.hpp>

Public Member Functions

std::vector< ComponentStatus > failedComponents () const
 Filter components down to the failed ones.
std::string summary () const
 Multi-line, human-readable summary suitable for logs and CLI output.

Public Attributes

bool ok {false}
std::vector< ComponentStatus > components {}

Detailed Description

Aggregate result of a probe call.

ok is true when every required component passed. The components vector preserves call order so callers can render a stable report.

Definition at line 50 of file Platform.hpp.

Member Function Documentation

◆ failedComponents()

std::vector< ComponentStatus > libstp::hal::platform::ProbeResult::failedComponents ( ) const
nodiscard

Filter components down to the failed ones.

◆ summary()

std::string libstp::hal::platform::ProbeResult::summary ( ) const
nodiscard

Multi-line, human-readable summary suitable for logs and CLI output.

Member Data Documentation

◆ components

std::vector<ComponentStatus> libstp::hal::platform::ProbeResult::components {}

Definition at line 53 of file Platform.hpp.

◆ ok

bool libstp::hal::platform::ProbeResult::ok {false}

Definition at line 52 of file Platform.hpp.


The documentation for this struct was generated from the following file:
  • /home/runner/work/raccoon-lib/raccoon-lib/modules/libstp-hal/include/hal/Platform.hpp