Nav2 Navigation Stack - humble  humble
ROS 2 Navigation Stack
Public Member Functions | Protected Attributes | List of all members
nav2_behaviors::Wait Class Reference

An action server behavior for waiting a fixed duration. More...

#include <nav2_behaviors/include/nav2_behaviors/plugins/wait.hpp>

Inheritance diagram for nav2_behaviors::Wait:
Inheritance graph
[legend]
Collaboration diagram for nav2_behaviors::Wait:
Collaboration graph
[legend]

Public Member Functions

 Wait ()
 A constructor for nav2_behaviors::Wait.
 
Status onRun (const std::shared_ptr< const WaitAction::Goal > command) override
 Initialization to run behavior. More...
 
Status onCycleUpdate () override
 Loop function to run behavior. More...
 
- Public Member Functions inherited from nav2_behaviors::TimedBehavior< WaitAction >
 TimedBehavior ()
 A TimedBehavior constructor.
 
virtual Status onRun (const std::shared_ptr< const typename ActionT::Goal > command)=0
 
virtual void onConfigure ()
 
virtual void onCleanup ()
 
virtual void onActionCompletion ()
 
void configure (const rclcpp_lifecycle::LifecycleNode::WeakPtr &parent, const std::string &name, std::shared_ptr< tf2_ros::Buffer > tf, std::shared_ptr< nav2_costmap_2d::CostmapTopicCollisionChecker > collision_checker) override
 
void cleanup () override
 Method to cleanup resources used on shutdown.
 
void activate () override
 Method to active Behavior and any threads involved in execution.
 
void deactivate () override
 Method to deactive Behavior and any threads involved in execution.
 
- Public Member Functions inherited from nav2_core::Behavior
virtual ~Behavior ()
 Virtual destructor.
 

Protected Attributes

rclcpp::Time wait_end_
 
WaitAction::Feedback::SharedPtr feedback_
 
- Protected Attributes inherited from nav2_behaviors::TimedBehavior< WaitAction >
rclcpp_lifecycle::LifecycleNode::WeakPtr node_
 
std::string behavior_name_
 
rclcpp_lifecycle::LifecyclePublisher< geometry_msgs::msg::Twist >::SharedPtr vel_pub_
 
std::shared_ptr< ActionServeraction_server_
 
std::shared_ptr< nav2_costmap_2d::CostmapTopicCollisionCheckercollision_checker_
 
std::shared_ptr< tf2_ros::Buffer > tf_
 
double cycle_frequency_
 
double enabled_
 
std::string global_frame_
 
std::string robot_base_frame_
 
double transform_tolerance_
 
rclcpp::Duration elasped_time_
 
rclcpp::Clock::SharedPtr clock_
 
rclcpp::Logger logger_
 

Additional Inherited Members

- Public Types inherited from nav2_behaviors::TimedBehavior< WaitAction >
using ActionServer = nav2_util::SimpleActionServer< WaitAction >
 
- Public Types inherited from nav2_core::Behavior
using Ptr = std::shared_ptr< Behavior >
 
- Protected Member Functions inherited from nav2_behaviors::TimedBehavior< WaitAction >
void execute ()
 
void stopRobot ()
 

Detailed Description

An action server behavior for waiting a fixed duration.

Definition at line 33 of file wait.hpp.

Member Function Documentation

◆ onCycleUpdate()

Status nav2_behaviors::Wait::onCycleUpdate ( )
overridevirtual

Loop function to run behavior.

Returns
Status of behavior

Implements nav2_behaviors::TimedBehavior< WaitAction >.

Definition at line 37 of file wait.cpp.

◆ onRun()

Status nav2_behaviors::Wait::onRun ( const std::shared_ptr< const WaitAction::Goal >  command)
override

Initialization to run behavior.

Parameters
commandGoal to execute
Returns
Status of behavior

Definition at line 31 of file wait.cpp.


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