Class HmsModule

• Defined in File hms.hpp

Inheritance Relationships

Base Type

• public rclcpp_lifecycle::LifecycleNode

Class Documentation

class HmsModule : public rclcpp_lifecycle::LifecycleNode

Public Functions

explicit HmsModule(const std::string &name)

Construct a new HmsModule object.

Parameters:

node_name – Name of the node

~HmsModule()

Destroy the HmsModule object.

CallbackReturn on_configure(const rclcpp_lifecycle::State &state)

Configures the HmsModule. Creates the ROS 2 subscribers and services.

Parameters:

state – rclcpp_lifecycle::State. Current state of the node.

Returns:

CallbackReturn SUCCESS or FAILURE

CallbackReturn on_activate(const rclcpp_lifecycle::State &state)

Activates the HmsModule.

Parameters:

state – rclcpp_lifecycle::State. Current state of the node.

Returns:

CallbackReturn SUCCESS or FAILURE

CallbackReturn on_cleanup(const rclcpp_lifecycle::State &state)

Cleans the HmsModule. Resets the ROS 2 subscribers and services.

Parameters:

state – rclcpp_lifecycle::State. Current state of the node.

Returns:

CallbackReturn SUCCESS or FAILURE

CallbackReturn on_deactivate(const rclcpp_lifecycle::State &state)

Deactivates the HmsModule.

Parameters:

state – rclcpp_lifecycle::State. Current state of the node.

Returns:

CallbackReturn SUCCESS or FAILURE

CallbackReturn on_shutdown(const rclcpp_lifecycle::State &state)

Shuts down the HmsModule.

Parameters:

state – rclcpp_lifecycle::State. Current state of the node.

Returns:

CallbackReturn SUCCESS or FAILURE

bool init()

Initialize the health monitoring system (HMS) module.

Note

Since the HMS module callback function involves a ROS2 publisher, this init method should be invoked after ROS2 elements have been initialized.

Returns:

true/false

bool deinit()

Deinitialize the health monitoring system (HMS) module.

Returns:

true/false

Public Members

std::string hms_return_codes_path_