system_health_check::SystemCheckBase Class Reference

Abstract base class for all system check plugins. More...

#include <system_health_check_base.hpp>

Public Member Functions
virtual	~SystemCheckBase ()
virtual bool	check (rclcpp::Node::SharedPtr node)=0
	Virtual function to execute the check.
virtual std::string	report (rclcpp::Node::SharedPtr node)=0
	Generates a detailed report of the check.

Detailed Description

Abstract base class for all system check plugins.

Any package that wants to perform a system check must inherit from this class and implement the check() and report() methods.

Constructor & Destructor Documentation

~SystemCheckBase()

virtual system_health_check::SystemCheckBase::~SystemCheckBase ( )

inlinevirtual

Member Function Documentation

check()

virtual bool system_health_check::SystemCheckBase::check ( rclcpp::Node::SharedPtr  node )

pure virtual

Virtual function to execute the check.

Parameters

node	Shared pointer to the ROS 2 node.

Returns

true: PASS, false: FAIL

report()

virtual std::string system_health_check::SystemCheckBase::report ( rclcpp::Node::SharedPtr  node )

pure virtual

Generates a detailed report of the check.

Parameters

node	Shared pointer to the ROS 2 node.

Returns

std::string A human-readable report string.

It should return a string containing diagnostic information (e.g., sensor values, error codes).

---

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

• src/system_health_check/include/system_health_check/base_class/system_health_check_base.hpp