Nav2 Navigation Stack - kilted  kilted
ROS 2 Navigation Stack
Public Types | Public Member Functions | List of all members
nav2_util::ClearEntirelyCostmapServiceClient Class Reference

A service client to clear costmaps entirely. More...

#include <nav2_util/include/nav2_util/clear_entirely_costmap_service_client.hpp>

Inheritance diagram for nav2_util::ClearEntirelyCostmapServiceClient:
Inheritance graph
[legend]
Collaboration diagram for nav2_util::ClearEntirelyCostmapServiceClient:
Collaboration graph
[legend]

Public Types

using clearEntirelyCostmapServiceRequest = nav2_util::ServiceClient< nav2_msgs::srv::ClearEntireCostmap >::RequestType
 
using clearEntirelyCostmapServiceResponse = nav2_util::ServiceClient< nav2_msgs::srv::ClearEntireCostmap >::ResponseType
 
- Public Types inherited from nav2_util::ServiceClient< nav2_msgs::srv::ClearEntireCostmap >
using RequestType = typename ServiceT::Request
 
using ResponseType = typename ServiceT::Response
 
using SharedPtr = std::shared_ptr< ServiceClient< nav2_msgs::srv::ClearEntireCostmap, rclcpp::Node::SharedPtr > >
 

Public Member Functions

 ClearEntirelyCostmapServiceClient (const std::string &service_name)
 A constructor for nav2_util::ClearEntirelyCostmapServiceClient.
 
- Public Member Functions inherited from nav2_util::ServiceClient< nav2_msgs::srv::ClearEntireCostmap >
 ServiceClient (const std::string &service_name, const rclcpp::Node::SharedPtr &provided_node, bool use_internal_executor=false)
 A constructor. More...
 
ResponseType::SharedPtr invoke (typename RequestType::SharedPtr &request, const std::chrono::nanoseconds timeout=std::chrono::nanoseconds(-1))
 Invoke the service and block until completed or timed out. More...
 
bool invoke (typename RequestType::SharedPtr &request, typename ResponseType::SharedPtr &response)
 Invoke the service and block until completed. More...
 
std::shared_future< typename ResponseType::SharedPtr > async_call (typename RequestType::SharedPtr &request)
 Asynchronously call the service. More...
 
void async_call (typename RequestType::SharedPtr request, CallbackT &&callback)
 Asynchronously call the service with a callback. More...
 
bool wait_for_service (const std::chrono::nanoseconds timeout=std::chrono::nanoseconds::max())
 Block until a service is available or timeout. More...
 
rclcpp::FutureReturnCode spin_until_complete (const FutureT &future, const std::chrono::nanoseconds timeout=std::chrono::nanoseconds(-1))
 Spins the executor until the provided future is complete or the timeout is reached. More...
 
std::string getServiceName ()
 Gets the service name. More...
 

Additional Inherited Members

- Protected Attributes inherited from nav2_util::ServiceClient< nav2_msgs::srv::ClearEntireCostmap >
std::string service_name_
 
rclcpp::Node::SharedPtr node_
 
rclcpp::CallbackGroup::SharedPtr callback_group_
 
rclcpp::executors::SingleThreadedExecutor::SharedPtr callback_group_executor_
 
rclcpp::Client< nav2_msgs::srv::ClearEntireCostmap >::SharedPtr client_
 
bool use_internal_executor_
 

Detailed Description

A service client to clear costmaps entirely.

Definition at line 29 of file clear_entirely_costmap_service_client.hpp.


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