OMPL
Overview
Download
Documentation
Primer
Installation
Tutorials
Demos
Python Bindings
Available Planners
Available State Spaces
FAQ
External links:
OMPL ROS Interface
OMPL ROS Tutorial
Code
API Overview
Classes
Files
Browse Repository
TeamCity Build Server
Issues
Community
Developers
Contributions
Education
Gallery
About
License
Citations
Acknowledgments
Contact Us
Blog
All
Classes
Namespaces
Functions
Variables
Typedefs
Enumerations
Enumerator
Friends
All
Classes
Namespaces
Files
Functions
Variables
Typedefs
Enumerations
Enumerator
Friends
Groups
Pages
src
ompl
base
PlannerTerminationCondition.h
1
/*********************************************************************
2
* Software License Agreement (BSD License)
3
*
4
* Copyright (c) 2011, Rice University
5
* All rights reserved.
6
*
7
* Redistribution and use in source and binary forms, with or without
8
* modification, are permitted provided that the following conditions
9
* are met:
10
*
11
* * Redistributions of source code must retain the above copyright
12
* notice, this list of conditions and the following disclaimer.
13
* * Redistributions in binary form must reproduce the above
14
* copyright notice, this list of conditions and the following
15
* disclaimer in the documentation and/or other materials provided
16
* with the distribution.
17
* * Neither the name of the Rice University nor the names of its
18
* contributors may be used to endorse or promote products derived
19
* from this software without specific prior written permission.
20
*
21
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
24
* FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
25
* COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
26
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
27
* BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
28
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
29
* CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
31
* ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
32
* POSSIBILITY OF SUCH DAMAGE.
33
*********************************************************************/
34
35
/* Author: Ioan Sucan */
36
37
#ifndef OMPL_BASE_PLANNER_TERMINATION_CONDITION_
38
#define OMPL_BASE_PLANNER_TERMINATION_CONDITION_
39
40
#include <boost/function.hpp>
41
#include <boost/thread.hpp>
42
43
namespace
ompl
44
{
45
46
namespace
base
47
{
48
56
typedef
boost::function<bool()>
PlannerTerminationConditionFn
;
57
64
class
PlannerTerminationCondition
65
{
66
public
:
67
71
PlannerTerminationCondition
(
const
PlannerTerminationConditionFn
&fn =
PlannerTerminationConditionFn
()) :
fn_
(fn),
terminate_
(false)
72
{
73
}
74
75
virtual
~
PlannerTerminationCondition
(
void
)
76
{
77
}
78
80
bool
operator()
(
void
)
const
81
{
82
return
terminate_
||
eval
();
83
}
84
87
void
terminate
(
void
)
const
;
88
90
virtual
bool
eval
(
void
)
const
;
91
92
protected
:
93
95
PlannerTerminationConditionFn
fn_
;
96
98
mutable
bool
terminate_
;
99
};
100
111
class
PlannerThreadedTerminationCondition
:
public
PlannerTerminationCondition
112
{
113
public
:
114
119
PlannerThreadedTerminationCondition
(
const
PlannerTerminationConditionFn
&fn,
double
period);
120
121
virtual
~
PlannerThreadedTerminationCondition
(
void
);
122
124
virtual
bool
eval
(
void
)
const
;
125
126
protected
:
127
129
bool
computeEval
(
void
);
130
132
void
startEvalThread
(
void
);
133
135
void
stopEvalThread
(
void
);
136
138
void
periodicEval
(
void
);
139
141
boost::thread *
thread_
;
142
144
bool
evalValue_
;
145
147
double
period_
;
148
};
149
151
class
PlannerNonTerminatingCondition
:
public
PlannerTerminationCondition
152
{
153
public
:
154
PlannerNonTerminatingCondition
(
void
);
155
};
156
158
class
PlannerAlwaysTerminatingCondition
:
public
PlannerTerminationCondition
159
{
160
public
:
161
PlannerAlwaysTerminatingCondition
(
void
);
162
};
163
165
class
PlannerOrTerminationCondition
:
public
PlannerTerminationCondition
166
{
167
public
:
168
PlannerOrTerminationCondition
(
const
PlannerTerminationCondition
&c1,
const
PlannerTerminationCondition
&c2);
169
};
170
172
class
PlannerAndTerminationCondition
:
public
PlannerTerminationCondition
173
{
174
public
:
175
PlannerAndTerminationCondition
(
const
PlannerTerminationCondition
&c1,
const
PlannerTerminationCondition
&c2);
176
};
177
179
PlannerTerminationCondition
timedPlannerTerminationCondition
(
double
duration);
180
182
PlannerThreadedTerminationCondition
timedPlannerTerminationCondition
(
double
duration,
double
interval);
183
}
184
}
185
186
#endif