Public Member Functions | Protected Member Functions
nav_core::RecoveryBehavior Class Reference

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>

List of all members.

Public Member Functions

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

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 47 of file recovery_behavior.h.


Constructor & Destructor Documentation

virtual nav_core::RecoveryBehavior::~RecoveryBehavior ( ) [inline, virtual]

Virtual destructor for the interface.

Definition at line 65 of file recovery_behavior.h.

Definition at line 68 of file recovery_behavior.h.


Member Function Documentation

virtual void nav_core::RecoveryBehavior::initialize ( std::string  name,
tf::TransformListener 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
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
autogenerated on Mon Oct 6 2014 02:45:09