ompl/geometric/PathGeometric.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_GEOMETRIC_PATH_GEOMETRIC_ 00038 #define OMPL_GEOMETRIC_PATH_GEOMETRIC_ 00039 00040 #include "ompl/base/SpaceInformation.h" 00041 #include "ompl/base/Path.h" 00042 #include <vector> 00043 #include <utility> 00044 00045 namespace ompl 00046 { 00047 namespace base 00048 { 00050 OMPL_CLASS_FORWARD(OptimizationObjective); 00052 } 00053 00055 namespace geometric 00056 { 00060 class PathGeometric : public base::Path 00061 { 00062 public: 00063 00065 PathGeometric(const base::SpaceInformationPtr &si) : base::Path(si) 00066 { 00067 } 00068 00070 PathGeometric(const PathGeometric &path); 00071 00073 PathGeometric(const base::SpaceInformationPtr &si, const base::State *state); 00074 00076 PathGeometric(const base::SpaceInformationPtr &si, const base::State *state1, const base::State *state2); 00077 00078 virtual ~PathGeometric() 00079 { 00080 freeMemory(); 00081 } 00082 00084 PathGeometric& operator=(const PathGeometric &other); 00085 00089 virtual base::Cost cost(const base::OptimizationObjectivePtr &obj) const; 00090 00092 virtual double length() const; 00093 00095 virtual bool check() const; 00096 00110 double smoothness() const; 00111 00123 double clearance() const; 00124 00126 virtual void print(std::ostream &out) const; 00131 virtual void printAsMatrix(std::ostream &out) const; 00132 00141 void interpolate(unsigned int count); 00142 00147 void interpolate(); 00148 00150 void subdivide(); 00151 00153 void reverse(); 00154 00166 std::pair<bool, bool> checkAndRepair(unsigned int attempts); 00167 00178 void overlay(const PathGeometric &over, unsigned int startIndex = 0); 00179 00181 void append(const base::State *state); 00182 00194 void append(const PathGeometric &path); 00195 00197 void prepend(const base::State *state); 00198 00200 void keepAfter(const base::State *state); 00201 00203 void keepBefore(const base::State *state); 00204 00206 void random(); 00207 00209 bool randomValid(unsigned int attempts); 00216 int getClosestIndex(const base::State *state) const; 00217 00219 std::vector<base::State*>& getStates() 00220 { 00221 return states_; 00222 } 00223 00225 base::State* getState(unsigned int index) 00226 { 00227 return states_[index]; 00228 } 00229 00231 const base::State* getState(unsigned int index) const 00232 { 00233 return states_[index]; 00234 } 00235 00237 std::size_t getStateCount() const 00238 { 00239 return states_.size(); 00240 } 00241 00244 protected: 00245 00247 void freeMemory(); 00248 00250 void copyFrom(const PathGeometric &other); 00251 00253 std::vector<base::State*> states_; 00254 }; 00255 00256 } 00257 } 00258 00259 #endif