mbf_abstract_core::AbstractRecovery 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 <abstract_recovery.h>

List of all members.

Public Types
typedef boost::shared_ptr < ::mbf_abstract_core::AbstractRecovery >	Ptr
Public Member Functions
virtual bool	cancel ()=0
	Requests the recovery behavior to cancel, e.g. if it takes too much time.
virtual uint32_t	runBehavior (std::string &message)=0
	Runs the AbstractRecovery.
virtual	~AbstractRecovery ()
	Virtual destructor for the interface.
Protected Member Functions
	AbstractRecovery ()
	Constructor.

---

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 52 of file abstract_recovery.h.

---

Member Typedef Documentation

typedef boost::shared_ptr< ::mbf_abstract_core::AbstractRecovery > mbf_abstract_core::AbstractRecovery::Ptr

Definition at line 55 of file abstract_recovery.h.

---

Constructor & Destructor Documentation

virtual mbf_abstract_core::AbstractRecovery::~AbstractRecovery

(

)

[inline, virtual]

Virtual destructor for the interface.

Definition at line 67 of file abstract_recovery.h.

mbf_abstract_core::AbstractRecovery::AbstractRecovery

(

)

[inline, protected]

Constructor.

Definition at line 79 of file abstract_recovery.h.

---

Member Function Documentation

virtual bool mbf_abstract_core::AbstractRecovery::cancel

(

)

[pure virtual]

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

Returns:

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

virtual uint32_t mbf_abstract_core::AbstractRecovery::runBehavior

(

std::string &

message

)

[pure virtual]

Runs the AbstractRecovery.

Parameters:

message

The recovery behavior could set, the message should correspond to the return value

Returns:

An outcome which will be hand over to the action result.

---

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

• abstract_recovery.h