include
mbf_mesh_core
mesh_recovery.h
Go to the documentation of this file.
1
/*
2
* Copyright 2020, 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
* author: Sebastian Pütz <spuetz@uni-osnabrueck.de>
34
*
35
*/
36
37
#ifndef MBF_MESH_CORE__ABSTRACT_RECOVERY_H
38
#define MBF_MESH_CORE__ABSTRACT_RECOVERY_H
39
40
#include <boost/shared_ptr.hpp>
41
#include <
mbf_abstract_core/abstract_recovery.h
>
42
#include <
mesh_map/mesh_map.h
>
43
#include <stdint.h>
44
#include <string>
45
46
namespace
mbf_mesh_core
47
{
54
class
MeshRecovery
:
public
mbf_abstract_core::AbstractRecovery
55
{
56
public
:
57
typedef
boost::shared_ptr<::mbf_mesh_core::MeshRecovery>
Ptr
;
58
65
virtual
uint32_t
runBehavior
(std::string& message) = 0;
66
70
virtual
~MeshRecovery
()
71
{
72
}
73
80
virtual
bool
cancel
() = 0;
81
89
virtual
bool
initialize
(
const
std::string& name,
const
boost::shared_ptr<tf2_ros::Buffer>
& tf_ptr,
90
const
boost::shared_ptr<mesh_map::MeshMap>
& mesh_map_ptr) = 0;
91
92
protected
:
96
MeshRecovery
(){};
97
};
98
};
/* namespace mbf_mesh_core */
99
100
#endif
/* MBF_MESH_CORE__ABSTRACT_RECOVERY_H */
mbf_mesh_core::MeshRecovery::runBehavior
virtual uint32_t runBehavior(std::string &message)=0
Runs the AbstractRecovery.
mbf_mesh_core::MeshRecovery::initialize
virtual bool initialize(const std::string &name, const boost::shared_ptr< tf2_ros::Buffer > &tf_ptr, const boost::shared_ptr< mesh_map::MeshMap > &mesh_map_ptr)=0
Initializes the recovery plugin with a name, a tf pointer and a mesh map pointer.
boost::shared_ptr
mbf_mesh_core::MeshRecovery::MeshRecovery
MeshRecovery()
Constructor.
Definition:
mesh_recovery.h:96
mbf_mesh_core::MeshRecovery
Provides an interface for recovery behaviors used in navigation. All recovery behaviors written as pl...
Definition:
mesh_recovery.h:54
mbf_mesh_core
Definition:
mesh_controller.h:49
mbf_mesh_core::MeshRecovery::Ptr
boost::shared_ptr<::mbf_mesh_core::MeshRecovery > Ptr
Definition:
mesh_recovery.h:57
abstract_recovery.h
mbf_mesh_core::MeshRecovery::~MeshRecovery
virtual ~MeshRecovery()
Virtual destructor for the interface.
Definition:
mesh_recovery.h:70
mbf_abstract_core::AbstractRecovery
mbf_mesh_core::MeshRecovery::cancel
virtual bool cancel()=0
Requests the recovery behavior to cancel, e.g. if it takes too much time.
mesh_map.h
mbf_mesh_core
Author(s): Sebastian Pütz
autogenerated on Thu Jan 25 2024 03:42:49