Common
common packages for kyubic
 
Loading...
Searching...
No Matches
system_health_check::checks::FailCheck Class Reference
+ Inheritance diagram for system_health_check::checks::FailCheck:
+ Collaboration diagram for system_health_check::checks::FailCheck:

Public Member Functions

bool check_impl (rclcpp::Node::SharedPtr node) override
 Actual implementation of the check logic.
 
std::string report_impl (rclcpp::Node::SharedPtr node) override
 Generates a detailed report of the check.
 
- Public Member Functions inherited from system_health_check::base::SystemCheckBase
virtual ~SystemCheckBase ()
 
bool check (rclcpp::Node::SharedPtr node)
 Executes the system check with caching support.
 
std::string report (rclcpp::Node::SharedPtr node)
 Generates a human-readable report of the check.
 

Additional Inherited Members

- Protected Member Functions inherited from system_health_check::base::SystemCheckBase
virtual std::string get_unique_id () const
 Generates a unique identifier for the check instance.
 
virtual void prepare_check (rclcpp::Node::SharedPtr node)
 Prepares the check before execution.
 
virtual bool check_impl (rclcpp::Node::SharedPtr node)=0
 Actual implementation of the check logic.
 
virtual std::string report_impl (rclcpp::Node::SharedPtr node)=0
 Generates a detailed report of the check.
 

Member Function Documentation

◆ check_impl()

bool system_health_check::checks::FailCheck::check_impl ( rclcpp::Node::SharedPtr  node)
inlineoverridevirtual

Actual implementation of the check logic.

Note
Derived classes must implement this function instead of check.
Parameters
nodeShared pointer to the ROS 2 node.
Returns
true if the check passes, false otherwise.

Implements system_health_check::base::SystemCheckBase.

◆ report_impl()

std::string system_health_check::checks::FailCheck::report_impl ( rclcpp::Node::SharedPtr  node)
inlineoverridevirtual

Generates a detailed report of the check.

Parameters
nodeShared 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).

Implements system_health_check::base::SystemCheckBase.


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