Nav2 Navigation Stack - kilted  kilted
ROS 2 Navigation Stack
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
nav2_smac_planner::SmacPlanner2D Class Reference
Inheritance diagram for nav2_smac_planner::SmacPlanner2D:
Inheritance graph
[legend]
Collaboration diagram for nav2_smac_planner::SmacPlanner2D:
Collaboration graph
[legend]

Public Member Functions

 SmacPlanner2D ()
 constructor
 
 ~SmacPlanner2D ()
 destructor
 
void configure (const rclcpp_lifecycle::LifecycleNode::WeakPtr &parent, std::string name, std::shared_ptr< tf2_ros::Buffer > tf, std::shared_ptr< nav2_costmap_2d::Costmap2DROS > costmap_ros) override
 Configuring plugin. More...
 
void cleanup () override
 Cleanup lifecycle node.
 
void activate () override
 Activate lifecycle node.
 
void deactivate () override
 Deactivate lifecycle node.
 
nav_msgs::msg::Path createPlan (const geometry_msgs::msg::PoseStamped &start, const geometry_msgs::msg::PoseStamped &goal, std::function< bool()> cancel_checker) override
 Creating a plan from start and goal poses. More...
 
- Public Member Functions inherited from nav2_core::GlobalPlanner
virtual ~GlobalPlanner ()
 Virtual destructor.
 

Protected Member Functions

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

Protected Attributes

std::unique_ptr< AStarAlgorithm< Node2D > > _a_star
 
GridCollisionChecker _collision_checker
 
std::unique_ptr< Smoother_smoother
 
nav2_costmap_2d::Costmap2D_costmap
 
std::unique_ptr< CostmapDownsampler_costmap_downsampler
 
rclcpp::Clock::SharedPtr _clock
 
rclcpp::Logger _logger {rclcpp::get_logger("SmacPlanner2D")}
 
std::string _global_frame
 
std::string _name
 
float _tolerance
 
int _downsampling_factor
 
bool _downsample_costmap
 
rclcpp_lifecycle::LifecyclePublisher< nav_msgs::msg::Path >::SharedPtr _raw_plan_publisher
 
double _max_planning_time
 
bool _allow_unknown
 
int _max_iterations
 
int _max_on_approach_iterations
 
int _terminal_checking_interval
 
bool _use_final_approach_orientation
 
SearchInfo _search_info
 
std::string _motion_model_for_search
 
MotionModel _motion_model
 
std::mutex _mutex
 
rclcpp_lifecycle::LifecycleNode::WeakPtr _node
 
rclcpp::node_interfaces::OnSetParametersCallbackHandle::SharedPtr _dyn_params_handler
 

Additional Inherited Members

- Public Types inherited from nav2_core::GlobalPlanner
using Ptr = std::shared_ptr< GlobalPlanner >
 

Detailed Description

Definition at line 41 of file smac_planner_2d.hpp.

Member Function Documentation

◆ configure()

void nav2_smac_planner::SmacPlanner2D::configure ( const rclcpp_lifecycle::LifecycleNode::WeakPtr &  parent,
std::string  name,
std::shared_ptr< tf2_ros::Buffer >  tf,
std::shared_ptr< nav2_costmap_2d::Costmap2DROS costmap_ros 
)
overridevirtual

Configuring plugin.

Parameters
parentLifecycle node pointer
nameName of plugin map
tfShared ptr of TF2 buffer
costmap_rosCostmap2DROS object

Implements nav2_core::GlobalPlanner.

Definition at line 48 of file smac_planner_2d.cpp.

◆ createPlan()

nav_msgs::msg::Path nav2_smac_planner::SmacPlanner2D::createPlan ( const geometry_msgs::msg::PoseStamped &  start,
const geometry_msgs::msg::PoseStamped &  goal,
std::function< bool()>  cancel_checker 
)
overridevirtual

Creating a plan from start and goal poses.

Parameters
startStart pose
goalGoal pose
cancel_checkerFunction to check if the action has been canceled
Returns
nav2_msgs::Path of the generated path

Implements nav2_core::GlobalPlanner.

Definition at line 206 of file smac_planner_2d.cpp.

References nav2_costmap_2d::Costmap2D::getResolution(), nav2_costmap_2d::FootprintCollisionChecker< CostmapT >::setCostmap(), and nav2_costmap_2d::Costmap2D::worldToMapContinuous().

Here is the call graph for this function:

◆ dynamicParametersCallback()

rcl_interfaces::msg::SetParametersResult nav2_smac_planner::SmacPlanner2D::dynamicParametersCallback ( std::vector< rclcpp::Parameter >  parameters)
protected

Callback executed when a parameter change is detected.

Parameters
eventParameterEvent message

Definition at line 356 of file smac_planner_2d.cpp.

Referenced by activate().

Here is the caller graph for this function:

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