mbf_nav_core_wrapper::WrapperRecoveryBehavior Class Reference

#include <wrapper_recovery_behavior.h>

Inheritance diagram for mbf_nav_core_wrapper::WrapperRecoveryBehavior:

Public Member Functions
virtual bool	cancel ()
	Requests the planner to cancel, e.g. if it takes too much time. More...
virtual void	initialize (std::string name, TF *tf, costmap_2d::Costmap2DROS *global_costmap, costmap_2d::Costmap2DROS *local_costmap)
	Initialization function for the CostmapRecovery. More...
virtual uint32_t	runBehavior (std::string &message)
	Runs the CostmapRecovery. More...
	WrapperRecoveryBehavior (boost::shared_ptr< nav_core::RecoveryBehavior > plugin)
	Public constructor used for handling a nav_core-based plugin. More...
virtual	~WrapperRecoveryBehavior ()
	Virtual destructor for the interface. More...
Public Member Functions inherited from mbf_costmap_core::CostmapRecovery
virtual	~CostmapRecovery ()
Public Member Functions inherited from mbf_abstract_core::AbstractRecovery
virtual	~AbstractRecovery ()

Private Attributes
boost::shared_ptr< nav_core::RecoveryBehavior >	nav_core_plugin_

Additional Inherited Members
Public Types inherited from mbf_costmap_core::CostmapRecovery
typedef boost::shared_ptr< ::mbf_costmap_core::CostmapRecovery >	Ptr
Public Types inherited from mbf_abstract_core::AbstractRecovery
typedef boost::shared_ptr< ::mbf_abstract_core::AbstractRecovery >	Ptr
Protected Member Functions inherited from mbf_costmap_core::CostmapRecovery
	CostmapRecovery ()
Protected Member Functions inherited from mbf_abstract_core::AbstractRecovery
	AbstractRecovery ()

Detailed Description

Definition at line 55 of file wrapper_recovery_behavior.h.

Constructor & Destructor Documentation

WrapperRecoveryBehavior()

mbf_nav_core_wrapper::WrapperRecoveryBehavior::WrapperRecoveryBehavior

(

boost::shared_ptr< nav_core::RecoveryBehavior >

plugin

)

Public constructor used for handling a nav_core-based plugin.

Parameters

plugin

Backward compatible plugin

Definition at line 65 of file wrapper_recovery_behavior.cpp.

~WrapperRecoveryBehavior()

mbf_nav_core_wrapper::WrapperRecoveryBehavior::~WrapperRecoveryBehavior ( )

virtual

Virtual destructor for the interface.

Definition at line 69 of file wrapper_recovery_behavior.cpp.

Member Function Documentation

cancel()

bool mbf_nav_core_wrapper::WrapperRecoveryBehavior::cancel ( )

virtual

Requests the planner to cancel, e.g. if it takes too much time.

Remarks

New on MBF API

Returns

True if a cancel has been successfully requested, false if not implemented.

Implements mbf_costmap_core::CostmapRecovery.

Definition at line 60 of file wrapper_recovery_behavior.cpp.

initialize()

void mbf_nav_core_wrapper::WrapperRecoveryBehavior::initialize ( std::string  name, TF *  tf, costmap_2d::Costmap2DROS *  global_costmap, costmap_2d::Costmap2DROS *  local_costmap  )

virtual

Initialization function for the CostmapRecovery.

Parameters

tf	A pointer to a transform listener
global_costmap	A pointer to the global_costmap used by the navigation stack
local_costmap	A pointer to the local_costmap used by the navigation stack

Implements mbf_costmap_core::CostmapRecovery.

Definition at line 46 of file wrapper_recovery_behavior.cpp.

runBehavior()

uint32_t mbf_nav_core_wrapper::WrapperRecoveryBehavior::runBehavior ( std::string &  message )

virtual

Runs the CostmapRecovery.

Implements mbf_costmap_core::CostmapRecovery.

Definition at line 53 of file wrapper_recovery_behavior.cpp.

Member Data Documentation

nav_core_plugin_

boost::shared_ptr< nav_core::RecoveryBehavior > mbf_nav_core_wrapper::WrapperRecoveryBehavior::nav_core_plugin_

private

Definition at line 92 of file wrapper_recovery_behavior.h.

---

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

• wrapper_recovery_behavior.h
• wrapper_recovery_behavior.cpp