abstract_recovery.h
Go to the documentation of this file.
1 /*
2  * Copyright 2018, Sebastian Pütz
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  *
8  * 1. Redistributions of source code must retain the above copyright
9  * notice, this list of conditions and the following disclaimer.
10  *
11  * 2. Redistributions in binary form must reproduce the above
12  * copyright notice, this list of conditions and the following
13  * disclaimer in the documentation and/or other materials provided
14  * with the distribution.
15  *
16  * 3. Neither the name of the copyright holder nor the names of its
17  * contributors may be used to endorse or promote products derived
18  * from this software without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
23  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
24  * COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
25  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
26  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
27  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
28  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
30  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
31  * POSSIBILITY OF SUCH DAMAGE.
32  *
33  * abstract_recovery.h
34  *
35  * author: Sebastian Pütz <spuetz@uni-osnabrueck.de>
36  *
37  */
38 
39 #ifndef MBF_ABSTRACT_CORE__ABSTRACT_RECOVERY_H_
40 #define MBF_ABSTRACT_CORE__ABSTRACT_RECOVERY_H_
41 
42 #include <stdint.h>
43 #include <string>
44 #include <boost/shared_ptr.hpp>
45 
46 namespace mbf_abstract_core {
53  public:
54 
56 
62  virtual uint32_t runBehavior(std::string& message) = 0;
63 
67  virtual ~AbstractRecovery(){}
68 
73  virtual bool cancel() = 0;
74 
75  protected:
80  };
81 }; /* namespace mbf_abstract_core */
82 
83 #endif /* MBF_ABSTRACT_CORE__ABSTRACT_RECOVERY_H_ */
mbf_abstract_core::AbstractRecovery::Ptr
boost::shared_ptr< ::mbf_abstract_core::AbstractRecovery > Ptr
Definition: abstract_recovery.h:55
boost::shared_ptr
mbf_abstract_core::AbstractRecovery::runBehavior
virtual uint32_t runBehavior(std::string &message)=0
Runs the AbstractRecovery.
mbf_abstract_core::AbstractRecovery::~AbstractRecovery
virtual ~AbstractRecovery()
Virtual destructor for the interface.
Definition: abstract_recovery.h:67
mbf_abstract_core
Definition: abstract_controller.h:49
mbf_abstract_core::AbstractRecovery::cancel
virtual bool cancel()=0
Requests the recovery behavior to cancel, e.g. if it takes too much time.
mbf_abstract_core::AbstractRecovery
Provides an interface for recovery behaviors used in navigation. All recovery behaviors written as pl...
Definition: abstract_recovery.h:52
mbf_abstract_core::AbstractRecovery::AbstractRecovery
AbstractRecovery()
Constructor.
Definition: abstract_recovery.h:79


mbf_abstract_core
Author(s): Sebastian Pütz , Jorge Santos
autogenerated on Wed Mar 2 2022 00:33:42