Public Types | Public Member Functions | Protected Member Functions | List of all members
mbf_abstract_core::AbstractRecovery 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 <abstract_recovery.h>

Public Types

typedef boost::shared_ptr< ::mbf_abstract_core::AbstractRecoveryPtr
 

Public Member Functions

virtual bool cancel ()=0
 Requests the recovery behavior to cancel, e.g. if it takes too much time. More...
 
virtual uint32_t runBehavior (std::string &message)=0
 Runs the AbstractRecovery. More...
 
virtual ~AbstractRecovery ()
 Virtual destructor for the interface. More...
 

Protected Member Functions

 AbstractRecovery ()
 Constructor. More...
 

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

◆ Ptr

Definition at line 55 of file abstract_recovery.h.

Constructor & Destructor Documentation

◆ ~AbstractRecovery()

virtual mbf_abstract_core::AbstractRecovery::~AbstractRecovery ( )
inlinevirtual

Virtual destructor for the interface.

Definition at line 67 of file abstract_recovery.h.

◆ AbstractRecovery()

mbf_abstract_core::AbstractRecovery::AbstractRecovery ( )
inlineprotected

Constructor.

Definition at line 79 of file abstract_recovery.h.

Member Function Documentation

◆ cancel()

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.

◆ runBehavior()

virtual uint32_t mbf_abstract_core::AbstractRecovery::runBehavior ( std::string &  message)
pure virtual

Runs the AbstractRecovery.

Parameters
messageThe 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:


mbf_abstract_core
Author(s): Sebastian Pütz , Jorge Santos
autogenerated on Wed May 27 2020 04:03:11