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
StateValidityChecker.h
1
/*********************************************************************
2
* Software License Agreement (BSD License)
3
*
4
* Copyright (c) 2008, Willow Garage, Inc.
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 Willow Garage 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_STATE_VALIDITY_CHECKER_
38
#define OMPL_BASE_STATE_VALIDITY_CHECKER_
39
40
#include "ompl/base/State.h"
41
#include "ompl/util/ClassForward.h"
42
43
namespace
ompl
44
{
45
46
namespace
base
47
{
48
50
ClassForward
(SpaceInformation);
52
54
55
ClassForward
(StateValidityChecker);
57
62
struct
StateValidityCheckerSpecs
63
{
64
enum
ClearanceComputationType
65
{
66
NONE = 0,
67
EXACT,
68
APPROXIMATE,
69
BOUNDED_APPROXIMATE,
70
};
71
72
StateValidityCheckerSpecs
(
void
) :
clearanceComputationType
(NONE),
hasValidDirectionComputation
(
false
)
73
{
74
}
75
78
ClearanceComputationType
clearanceComputationType
;
79
82
bool
hasValidDirectionComputation
;
83
};
84
88
class
StateValidityChecker
89
{
90
public
:
91
93
StateValidityChecker
(
SpaceInformation
* si) :
si_
(si)
94
{
95
}
96
98
StateValidityChecker
(
const
SpaceInformationPtr
&si) :
si_
(si.get())
99
{
100
}
101
102
virtual
~
StateValidityChecker
(
void
)
103
{
104
}
105
109
virtual
bool
isValid
(
const
State *state)
const
= 0;
110
112
virtual
bool
isValid
(
const
State
*state,
double
&dist)
const
113
{
114
dist =
clearance
(state);
115
return
isValid
(state);
116
}
117
122
virtual
bool
isValid
(
const
State
*state,
double
&dist,
State
*validState,
bool
&validStateAvailable)
const
123
{
124
dist =
clearance
(state, validState, validStateAvailable);
125
return
isValid
(state);
126
}
127
130
virtual
double
clearance
(
const
State
*state)
const
131
{
132
return
0.0;
133
}
134
138
virtual
double
clearance
(
const
State
*state,
State
*validState,
bool
&validStateAvailable)
const
139
{
140
validStateAvailable =
false
;
141
return
clearance
(state);
142
}
143
145
const
StateValidityCheckerSpecs
&
getSpecs
(
void
)
const
146
{
147
return
specs_
;
148
}
149
150
protected
:
151
153
SpaceInformation
*
si_
;
154
156
StateValidityCheckerSpecs
specs_
;
157
158
};
159
161
class
AllValidStateValidityChecker
:
public
StateValidityChecker
162
{
163
public
:
164
166
AllValidStateValidityChecker
(
SpaceInformation
* si) :
StateValidityChecker
(si)
167
{
168
}
169
171
AllValidStateValidityChecker
(
const
SpaceInformationPtr
&si) :
StateValidityChecker
(si)
172
{
173
}
174
176
virtual
bool
isValid
(
const
State
*
/* state */
)
const
177
{
178
return
true
;
179
}
180
};
181
182
}
183
}
184
185
#endif