opennav_following::ParameterHandler Class Reference

Handles parameters and dynamic parameters for Following Server. More...

#include <nav2_following/opennav_following/include/opennav_following/parameter_handler.hpp>

Collaboration diagram for opennav_following::ParameterHandler:

Public Member Functions
	ParameterHandler (const nav2_util::LifecycleNode::SharedPtr &node, const rclcpp::Logger &logger)
	Constructor for opennav_following::ParameterHandler.
	~ParameterHandler ()=default
	Destructor for opennav_following::ParameterHandler.
std::mutex &	getMutex ()
	Get the internal mutex used for thread-safe parameter access. More...
Parameters *	getParams ()
	Get a pointer to the internal parameter structure. More...
void	activate ()
	Registers callbacks for dynamic parameter handling.
void	deactivate ()
	Resets callbacks for dynamic parameter handling.

Protected Member Functions
rcl_interfaces::msg::SetParametersResult	dynamicParametersCallback (const std::vector< rclcpp::Parameter > &parameters)
	Callback executed when a parameter change is detected. More...

Protected Attributes
nav2_util::LifecycleNode::WeakPtr	node_
std::mutex	mutex_
Parameters	params_
rclcpp::Logger	logger_
rclcpp::node_interfaces::OnSetParametersCallbackHandle::SharedPtr	dyn_params_handler_

Detailed Description

Handles parameters and dynamic parameters for Following Server.

Definition at line 70 of file parameter_handler.hpp.

Member Function Documentation

dynamicParametersCallback()

rcl_interfaces::msg::SetParametersResult opennav_following::ParameterHandler::dynamicParametersCallback ( const std::vector< rclcpp::Parameter > &  parameters )

protected

Callback executed when a parameter change is detected.

Parameters

parameters

List of parameters that are being updated.

Returns

rcl_interfaces::msg::SetParametersResult Result indicating acceptance.

Definition at line 109 of file parameter_handler.cpp.

Referenced by activate().

Here is the caller graph for this function:

getMutex()

std::mutex& opennav_following::ParameterHandler::getMutex ( )

inline

Get the internal mutex used for thread-safe parameter access.

Returns

Reference to the mutex.

Definition at line 89 of file parameter_handler.hpp.

getParams()

Parameters* opennav_following::ParameterHandler::getParams ( )

inline

Get a pointer to the internal parameter structure.

Returns

Pointer to the stored parameter structure.

Definition at line 95 of file parameter_handler.hpp.

---

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

• nav2_following/opennav_following/include/opennav_following/parameter_handler.hpp
• nav2_following/opennav_following/src/parameter_handler.cpp