Public Member Functions | Protected Member Functions | List of all members
nav_core::RecoveryBehavior Class Referenceabstract

Provides an interface for recovery behaviors used in navigation. All recovery behaviors written as plugins for the navigation stack must adhere to this interface. More...

#include <recovery_behavior.h>

Public Member Functions

virtual void initialize (std::string name, tf2_ros::Buffer *tf, costmap_2d::Costmap2DROS *global_costmap, costmap_2d::Costmap2DROS *local_costmap)=0
 Initialization function for the RecoveryBehavior. More...
 
virtual void runBehavior ()=0
 Runs the RecoveryBehavior. More...
 
virtual ~RecoveryBehavior ()
 Virtual destructor for the interface. More...
 

Protected Member Functions

 RecoveryBehavior ()
 

Detailed Description

Provides an interface for recovery behaviors used in navigation. All recovery behaviors written as plugins for the navigation stack must adhere to this interface.

Definition at line 83 of file recovery_behavior.h.

Constructor & Destructor Documentation

◆ ~RecoveryBehavior()

virtual nav_core::RecoveryBehavior::~RecoveryBehavior ( )
inlinevirtual

Virtual destructor for the interface.

Definition at line 101 of file recovery_behavior.h.

◆ RecoveryBehavior()

nav_core::RecoveryBehavior::RecoveryBehavior ( )
inlineprotected

Definition at line 104 of file recovery_behavior.h.

Member Function Documentation

◆ initialize()

virtual void nav_core::RecoveryBehavior::initialize ( std::string  name,
tf2_ros::Buffer tf,
costmap_2d::Costmap2DROS global_costmap,
costmap_2d::Costmap2DROS local_costmap 
)
pure virtual

Initialization function for the RecoveryBehavior.

Parameters
tfA pointer to a transform listener
global_costmapA pointer to the global_costmap used by the navigation stack
local_costmapA pointer to the local_costmap used by the navigation stack

◆ runBehavior()

virtual void nav_core::RecoveryBehavior::runBehavior ( )
pure virtual

Runs the RecoveryBehavior.


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


nav_core
Author(s): Eitan Marder-Eppstein, contradict@gmail.com
autogenerated on Sat Dec 3 2022 03:49:31