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>
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.
virtual mbf_abstract_core::AbstractRecovery::~AbstractRecovery |
( |
| ) |
|
|
inlinevirtual |
mbf_abstract_core::AbstractRecovery::AbstractRecovery |
( |
| ) |
|
|
inlineprotected |
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: