Nav2 Navigation Stack - kilted  kilted
ROS 2 Navigation Stack
Public Member Functions | Static Public Member Functions | List of all members
nav2_behavior_tree::WaitCancel Class Reference

A nav2_behavior_tree::BtActionNode class that wraps nav2_msgs::action::Wait. More...

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

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

Public Member Functions

 WaitCancel (const std::string &xml_tag_name, const std::string &action_name, const BT::NodeConfiguration &conf)
 A constructor for nav2_behavior_tree::WaitAction. More...
 
- Public Member Functions inherited from nav2_behavior_tree::BtCancelActionNode< nav2_msgs::action::Wait >
 BtCancelActionNode (const std::string &xml_tag_name, const std::string &action_name, const BT::NodeConfiguration &conf)
 A nav2_behavior_tree::BtCancelActionNode constructor. More...
 
void createActionClient (const std::string &action_name)
 Create instance of an action client. More...
 
void halt () override
 
BT::NodeStatus tick () override
 The main override required by a BT action. More...
 

Static Public Member Functions

static BT::PortsList providedPorts ()
 Creates list of BT ports. More...
 
- Static Public Member Functions inherited from nav2_behavior_tree::BtCancelActionNode< nav2_msgs::action::Wait >
static BT::PortsList providedBasicPorts (BT::PortsList addition)
 Any subclass of BtCancelActionNode 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 Attributes inherited from nav2_behavior_tree::BtCancelActionNode< nav2_msgs::action::Wait >
std::string action_name_
 
std::shared_ptr< rclcpp_action::Client< nav2_msgs::action::Wait > > action_client_
 
rclcpp::Node::SharedPtr node_
 
rclcpp::CallbackGroup::SharedPtr callback_group_
 
rclcpp::executors::SingleThreadedExecutor callback_group_executor_
 
std::chrono::milliseconds server_timeout_
 
std::chrono::milliseconds wait_for_service_timeout_
 

Detailed Description

A nav2_behavior_tree::BtActionNode class that wraps nav2_msgs::action::Wait.

Definition at line 31 of file wait_cancel_node.hpp.

Constructor & Destructor Documentation

◆ WaitCancel()

nav2_behavior_tree::WaitCancel::WaitCancel ( const std::string &  xml_tag_name,
const std::string &  action_name,
const BT::NodeConfiguration &  conf 
)

A constructor for nav2_behavior_tree::WaitAction.

Parameters
xml_tag_nameName for the XML tag for this node
action_nameAction name this node creates a client for
confBT node configuration

Definition at line 25 of file wait_cancel_node.cpp.

Member Function Documentation

◆ providedPorts()

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

Creates list of BT ports.

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

Definition at line 49 of file wait_cancel_node.hpp.

References nav2_behavior_tree::BtCancelActionNode< nav2_msgs::action::Wait >::providedBasicPorts().

Here is the call graph for this function:

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