Nav2 Navigation Stack - rolling  main
ROS 2 Navigation Stack
Public Member Functions | Static Public Member Functions | List of all members
nav2_behavior_tree::ClearCostmapAroundRobotService Class Reference

A nav2_behavior_tree::BtServiceNode class that wraps nav2_msgs::srv::ClearCostmapAroundRobot. More...

#include <nav2_behavior_tree/include/nav2_behavior_tree/plugins/action/clear_costmap_service.hpp>

Inheritance diagram for nav2_behavior_tree::ClearCostmapAroundRobotService:
Inheritance graph
[legend]
Collaboration diagram for nav2_behavior_tree::ClearCostmapAroundRobotService:
Collaboration graph
[legend]

Public Member Functions

 ClearCostmapAroundRobotService (const std::string &service_node_name, const BT::NodeConfiguration &conf)
 A constructor for nav2_behavior_tree::ClearCostmapAroundRobotService. More...
 
void on_tick () override
 The main override required by a BT service. More...
 
- Public Member Functions inherited from nav2_behavior_tree::BtServiceNode< nav2_msgs::srv::ClearCostmapAroundRobot >
 BtServiceNode (const std::string &service_node_name, const BT::NodeConfiguration &conf, const std::string &service_name="")
 A nav2_behavior_tree::BtServiceNode constructor. More...
 
void initialize ()
 Function to read parameters and initialize class variables.
 
void createROSInterfaces ()
 Function to create ROS interfaces.
 
BT::NodeStatus tick () override
 The main override required by a BT service. More...
 
void halt () override
 The other (optional) override required by a BT service.
 
virtual BT::NodeStatus on_completion (std::shared_ptr< typename ServiceT::Response >)
 Function to perform some user-defined operation upon successful completion of the service. Could put a value on the blackboard. More...
 
virtual BT::NodeStatus check_future ()
 Check the future and decide the status of BT. More...
 
virtual void on_wait_for_result ()
 Function to perform some user-defined operation after a timeout waiting for a result that hasn't been received yet.
 

Static Public Member Functions

static BT::PortsList providedPorts ()
 Creates list of BT ports. More...
 
- Static Public Member Functions inherited from nav2_behavior_tree::BtServiceNode< nav2_msgs::srv::ClearCostmapAroundRobot >
static BT::PortsList providedBasicPorts (BT::PortsList addition)
 Any subclass of BtServiceNode that accepts parameters must provide a providedPorts method and call providedBasicPorts in it. More...
 
static BT::PortsList providedPorts ()
 Creates list of BT ports. More...
 

Additional Inherited Members

- Protected Member Functions inherited from nav2_behavior_tree::BtServiceNode< nav2_msgs::srv::ClearCostmapAroundRobot >
void increment_recovery_count ()
 Function to increment recovery count on blackboard if this node wraps a recovery.
 
- Protected Attributes inherited from nav2_behavior_tree::BtServiceNode< nav2_msgs::srv::ClearCostmapAroundRobot >
std::string service_name_
 
std::string service_node_name_
 
nav2::ServiceClient< nav2_msgs::srv::ClearCostmapAroundRobot >::SharedPtr service_client_
 
std::shared_ptr< typename ServiceT::Request > request_
 
nav2::LifecycleNode::SharedPtr node_
 
std::chrono::milliseconds server_timeout_
 
std::chrono::milliseconds max_timeout_
 
std::chrono::milliseconds wait_for_service_timeout_
 
std::shared_future< typename ServiceT::Response::SharedPtr > future_result_
 
bool request_sent_
 
rclcpp::Time sent_time_
 
bool should_send_request_
 

Detailed Description

A nav2_behavior_tree::BtServiceNode class that wraps nav2_msgs::srv::ClearCostmapAroundRobot.

Note
This is an Asynchronous (long-running) node which may return a RUNNING state while executing. It will re-initialize when halted.

Definition at line 100 of file clear_costmap_service.hpp.

Constructor & Destructor Documentation

◆ ClearCostmapAroundRobotService()

nav2_behavior_tree::ClearCostmapAroundRobotService::ClearCostmapAroundRobotService ( const std::string &  service_node_name,
const BT::NodeConfiguration &  conf 
)

A constructor for nav2_behavior_tree::ClearCostmapAroundRobotService.

Parameters
service_node_nameService name this node creates a client for
confBT node configuration

Definition at line 48 of file clear_costmap_service.cpp.

Member Function Documentation

◆ on_tick()

void nav2_behavior_tree::ClearCostmapAroundRobotService::on_tick ( )
overridevirtual

The main override required by a BT service.

Returns
BT::NodeStatus Status of tick execution

Reimplemented from nav2_behavior_tree::BtServiceNode< nav2_msgs::srv::ClearCostmapAroundRobot >.

Definition at line 55 of file clear_costmap_service.cpp.

References nav2_behavior_tree::BtServiceNode< nav2_msgs::srv::ClearCostmapAroundRobot >::increment_recovery_count().

Here is the call graph for this function:

◆ providedPorts()

static BT::PortsList nav2_behavior_tree::ClearCostmapAroundRobotService::providedPorts ( )
inlinestatic

Creates list of BT ports.

Returns
BT::PortsList Containing basic ports along with node-specific ports

Definition at line 122 of file clear_costmap_service.hpp.

References nav2_behavior_tree::BtServiceNode< nav2_msgs::srv::ClearCostmapAroundRobot >::providedBasicPorts().

Here is the call graph for this function:

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