Master Class Reference

Represents the master node that manages multiple cognitive modules within a ROS 2 lifecycle-based robotic system. More...

#include <Master.hpp>

Inheritance diagram for Master:

Collaboration diagram for Master:

Public Types
using	CallbackReturnT = rclcpp_lifecycle::node_interfaces::LifecycleNodeInterface::CallbackReturn

Public Member Functions
	Master (const rclcpp::NodeOptions &options=rclcpp::NodeOptions())
	Constructs a Master lifecycle node with the specified options.
CallbackReturnT	on_activate (const rclcpp_lifecycle::State &state)
	Activates the Master node.
CallbackReturnT	on_cleanup (const rclcpp_lifecycle::State &state)
	Cleans up the Master node.
CallbackReturnT	on_configure (const rclcpp_lifecycle::State &state)
	Configures the Master node.
CallbackReturnT	on_deactivate (const rclcpp_lifecycle::State &state)
	Deactivates the Master node.
CallbackReturnT	on_error (const rclcpp_lifecycle::State &state)
	Handles errors in the Master node.
CallbackReturnT	on_shutdown (const rclcpp_lifecycle::State &state)
	Shuts down the Master node.

Protected Attributes
std::map< std::string, cs4home_core::CognitiveModule::SharedPtr >	cog_modules_
	Map of cognitive modules managed by the Master node.

Detailed Description

Represents the master node that manages multiple cognitive modules within a ROS 2 lifecycle-based robotic system.

Member Typedef Documentation

CallbackReturnT

using CallbackReturnT = rclcpp_lifecycle::node_interfaces::LifecycleNodeInterface::CallbackReturn

Constructor & Destructor Documentation

Master()

Master ( const rclcpp::NodeOptions & options = rclcpp::NodeOptions() )

explicit

Constructs a Master lifecycle node with the specified options.

Parameters

options

Node options to configure the Master node.

Member Function Documentation

on_activate()

CallbackReturnT on_activate

(

const rclcpp_lifecycle::State &

state

)

Activates the Master node.

Parameters

state

The current lifecycle state.

Returns

CallbackReturnT::SUCCESS if activation is successful.

on_cleanup()

CallbackReturnT on_cleanup

(

const rclcpp_lifecycle::State &

state

)

Cleans up the Master node.

Parameters

state

The current lifecycle state.

Returns

CallbackReturnT::SUCCESS indicating cleanup is complete.

on_configure()

CallbackReturnT on_configure

(

const rclcpp_lifecycle::State &

state

)

Configures the Master node.

Parameters

state

The current lifecycle state.

Returns

CallbackReturnT::SUCCESS if configuration is successful.

on_deactivate()

CallbackReturnT on_deactivate

(

const rclcpp_lifecycle::State &

state

)

Deactivates the Master node.

Parameters

state

The current lifecycle state.

Returns

CallbackReturnT::SUCCESS if deactivation is successful.

on_error()

CallbackReturnT on_error

(

const rclcpp_lifecycle::State &

state

)

Handles errors in the Master node.

Parameters

state

The current lifecycle state.

Returns

CallbackReturnT::SUCCESS indicating error handling is complete.

on_shutdown()

CallbackReturnT on_shutdown

(

const rclcpp_lifecycle::State &

state

)

Shuts down the Master node.

Parameters

state

The current lifecycle state.

Returns

CallbackReturnT::SUCCESS indicating shutdown is complete.

Member Data Documentation

cog_modules_

std::map<std::string, cs4home_core::CognitiveModule::SharedPtr> cog_modules_

protected

Map of cognitive modules managed by the Master node.

---

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

• cs4home_core/include/cs4home_core/Master.hpp
• cs4home_core/src/cs4home_core/Master.cpp