voxl::HealthCheck Class Reference

Health monitoring system for VOXL OpenVINS. More...

#include <VoxlHK.h>

Public Member Functions
	HealthCheck (const HealthCheck &)=delete
HealthCheck &	operator= (const HealthCheck &)=delete
void	start ()
	Start the health check system.
void	stop ()
	Stop the health check system.
bool	isRunning () const
	Check if health monitoring is running.

Static Public Member Functions
static HealthCheck &	getInstance ()
	Get singleton instance.
static void	clearErrorCodes (uint32_t error_mask)
	Clear specific error codes.
static void	clearErrorCodes (uint32_t error_mask, bool clear_all)
	Clear specific error codes.

Detailed Description

Health monitoring system for VOXL OpenVINS.

This class provides comprehensive health monitoring capabilities for the VIO system, including error code monitoring, system state checks, and performance monitoring. It runs at 30Hz and continuously monitors the system health.

Definition at line 286 of file VoxlHK.h.

Member Function Documentation

clearErrorCodes() [1/2]

static void voxl::HealthCheck::clearErrorCodes ( uint32_t  error_mask )

inlinestatic

Clear specific error codes.

Clears the specified error codes from the global error state. This is useful when errors are resolved and should no longer be reported.

Parameters

error_mask	Bit mask of error codes to clear
clear_all	If true, clear all error codes

Definition at line 334 of file VoxlHK.h.

References clearErrorCodes().

Referenced by clearErrorCodes().

Here is the call graph for this function:

Here is the caller graph for this function:

clearErrorCodes() [2/2]

void HealthCheck::clearErrorCodes ( uint32_t  error_mask, bool  clear_all  )

static

Clear specific error codes.

Clears the specified error codes from the global error state. This is useful when errors are resolved and should no longer be reported.

Parameters

error_mask

Bit mask of error codes to clear

Definition at line 575 of file VoxlHealth.cpp.

References en_debug, and vio_error_codes.

getInstance()

static HealthCheck & voxl::HealthCheck::getInstance ( )

inlinestatic

Get singleton instance.

Returns

Reference to the singleton HealthCheck instance

Definition at line 293 of file VoxlHK.h.

Referenced by voxl::Publisher::start(), and voxl::Publisher::stop().

Here is the caller graph for this function:

isRunning()

bool voxl::HealthCheck::isRunning ( ) const

inline

Check if health monitoring is running.

Returns

true if health check is active, false otherwise

Definition at line 322 of file VoxlHK.h.

start()

void HealthCheck::start

(

)

Start the health check system.

Initializes and starts the health monitoring thread that runs at 30Hz. The thread continuously monitors system health and error conditions.

Definition at line 49 of file VoxlHealth.cpp.

Referenced by voxl::Publisher::start().

Here is the caller graph for this function:

stop()

void HealthCheck::stop

(

)

Stop the health check system.

Stops the health monitoring thread and performs cleanup.

Definition at line 71 of file VoxlHealth.cpp.

Referenced by voxl::Publisher::stop().

Here is the caller graph for this function:

---

The documentation for this class was generated from the following files:

• VoxlCore/VoxlHK.h
• VoxlCore/VoxlHealth.cpp