Nav2 Navigation Stack - rolling  main
ROS 2 Navigation Stack
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
nav2_regulated_pure_pursuit_controller::ParameterHandler Class Reference

Handles parameters and dynamic parameters for RPP. More...

#include <nav2_regulated_pure_pursuit_controller/include/nav2_regulated_pure_pursuit_controller/parameter_handler.hpp>

Collaboration diagram for nav2_regulated_pure_pursuit_controller::ParameterHandler:
Collaboration graph
[legend]

Public Member Functions

 ParameterHandler (nav2::LifecycleNode::SharedPtr node, std::string &plugin_name, rclcpp::Logger &logger, const double costmap_size_x)
 Constructor for nav2_regulated_pure_pursuit_controller::ParameterHandler.
 
 ~ParameterHandler ()
 Destrructor for nav2_regulated_pure_pursuit_controller::ParameterHandler.
 
std::mutex & getMutex ()
 
ParametersgetParams ()
 
void activate ()
 Registers callbacks for dynamic parameter handling.
 
void deactivate ()
 Resets callbacks for dynamic parameter handling.
 

Protected Member Functions

void updateParametersCallback (std::vector< rclcpp::Parameter > parameters)
 Apply parameter updates after validation This callback is executed when parameters have been successfully updated. It updates the internal configuration of the node with the new parameter values. More...
 
rcl_interfaces::msg::SetParametersResult validateParameterUpdatesCallback (std::vector< rclcpp::Parameter > parameters)
 Validate incoming parameter updates before applying them. This callback is triggered when one or more parameters are about to be updated. It checks the validity of parameter values and rejects updates that would lead to invalid or inconsistent configurations. More...
 

Protected Attributes

nav2::LifecycleNode::WeakPtr node_
 
std::mutex mutex_
 
rclcpp::node_interfaces::PostSetParametersCallbackHandle::SharedPtr post_set_params_handler_
 
rclcpp::node_interfaces::OnSetParametersCallbackHandle::SharedPtr on_set_params_handler_
 
Parameters params_
 
std::string plugin_name_
 
rclcpp::Logger logger_ {rclcpp::get_logger("RegulatedPurePursuitController")}
 

Detailed Description

Handles parameters and dynamic parameters for RPP.

Definition at line 72 of file parameter_handler.hpp.

Member Function Documentation

◆ updateParametersCallback()

void nav2_regulated_pure_pursuit_controller::ParameterHandler::updateParametersCallback ( std::vector< rclcpp::Parameter >  parameters)
protected

Apply parameter updates after validation This callback is executed when parameters have been successfully updated. It updates the internal configuration of the node with the new parameter values.

Parameters
parametersList of parameters that have been updated.

Definition at line 272 of file parameter_handler.cpp.

Referenced by activate().

Here is the caller graph for this function:

◆ validateParameterUpdatesCallback()

rcl_interfaces::msg::SetParametersResult nav2_regulated_pure_pursuit_controller::ParameterHandler::validateParameterUpdatesCallback ( std::vector< rclcpp::Parameter >  parameters)
protected

Validate incoming parameter updates before applying them. This callback is triggered when one or more parameters are about to be updated. It checks the validity of parameter values and rejects updates that would lead to invalid or inconsistent configurations.

Parameters
parametersList of parameters that are being updated.
Returns
rcl_interfaces::msg::SetParametersResult Result indicating whether the update is accepted.

Definition at line 232 of file parameter_handler.cpp.

Referenced by activate().

Here is the caller graph for this function:

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