ompl/base/StateValidityChecker.h
00001 /********************************************************************* 00002 * Software License Agreement (BSD License) 00003 * 00004 * Copyright (c) 2008, Willow Garage, Inc. 00005 * All rights reserved. 00006 * 00007 * Redistribution and use in source and binary forms, with or without 00008 * modification, are permitted provided that the following conditions 00009 * are met: 00010 * 00011 * * Redistributions of source code must retain the above copyright 00012 * notice, this list of conditions and the following disclaimer. 00013 * * Redistributions in binary form must reproduce the above 00014 * copyright notice, this list of conditions and the following 00015 * disclaimer in the documentation and/or other materials provided 00016 * with the distribution. 00017 * * Neither the name of the Willow Garage nor the names of its 00018 * contributors may be used to endorse or promote products derived 00019 * from this software without specific prior written permission. 00020 * 00021 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 00022 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 00023 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS 00024 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE 00025 * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, 00026 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 00027 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 00028 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER 00029 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 00030 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN 00031 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 00032 * POSSIBILITY OF SUCH DAMAGE. 00033 *********************************************************************/ 00034 00035 /* Author: Ioan Sucan */ 00036 00037 #ifndef OMPL_BASE_STATE_VALIDITY_CHECKER_ 00038 #define OMPL_BASE_STATE_VALIDITY_CHECKER_ 00039 00040 #include "ompl/base/State.h" 00041 #include "ompl/util/ClassForward.h" 00042 00043 namespace ompl 00044 { 00045 00046 namespace base 00047 { 00048 00050 OMPL_CLASS_FORWARD(SpaceInformation); 00052 00054 00055 OMPL_CLASS_FORWARD(StateValidityChecker); 00057 00062 struct StateValidityCheckerSpecs 00063 { 00065 enum ClearanceComputationType 00066 { 00068 NONE = 0, 00070 EXACT, 00072 APPROXIMATE, 00074 BOUNDED_APPROXIMATE, 00075 }; 00076 00077 StateValidityCheckerSpecs() : clearanceComputationType(NONE), hasValidDirectionComputation(false) 00078 { 00079 } 00080 00083 ClearanceComputationType clearanceComputationType; 00084 00087 bool hasValidDirectionComputation; 00088 }; 00089 00093 class StateValidityChecker 00094 { 00095 public: 00096 00098 StateValidityChecker(SpaceInformation *si) : si_(si) 00099 { 00100 } 00101 00103 StateValidityChecker(const SpaceInformationPtr &si) : si_(si.get()) 00104 { 00105 } 00106 00107 virtual ~StateValidityChecker() 00108 { 00109 } 00110 00114 virtual bool isValid(const State *state) const = 0; 00115 00117 virtual bool isValid(const State *state, double &dist) const 00118 { 00119 dist = clearance(state); 00120 return isValid(state); 00121 } 00122 00127 virtual bool isValid(const State *state, double &dist, State *validState, bool &validStateAvailable) const 00128 { 00129 dist = clearance(state, validState, validStateAvailable); 00130 return isValid(state); 00131 } 00132 00135 virtual double clearance(const State* /*state*/) const 00136 { 00137 return 0.0; 00138 } 00139 00143 virtual double clearance(const State *state, State* /*validState*/, bool &validStateAvailable) const 00144 { 00145 validStateAvailable = false; 00146 return clearance(state); 00147 } 00148 00150 const StateValidityCheckerSpecs& getSpecs() const 00151 { 00152 return specs_; 00153 } 00154 00155 protected: 00156 00158 SpaceInformation *si_; 00159 00161 StateValidityCheckerSpecs specs_; 00162 00163 }; 00164 00166 class AllValidStateValidityChecker : public StateValidityChecker 00167 { 00168 public: 00169 00171 AllValidStateValidityChecker(SpaceInformation *si) : StateValidityChecker(si) 00172 { 00173 } 00174 00176 AllValidStateValidityChecker(const SpaceInformationPtr &si) : StateValidityChecker(si) 00177 { 00178 } 00179 00181 virtual bool isValid(const State * /* state */ ) const 00182 { 00183 return true; 00184 } 00185 }; 00186 00187 } 00188 } 00189 00190 #endif