ompl/base/ValidStateSampler.h
00001 /********************************************************************* 00002 * Software License Agreement (BSD License) 00003 * 00004 * Copyright (c) 2010, Rice University 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 Rice University 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_VALID_STATE_SAMPLER_ 00038 #define OMPL_BASE_VALID_STATE_SAMPLER_ 00039 00040 #include "ompl/base/State.h" 00041 #include "ompl/util/ClassForward.h" 00042 #include "ompl/base/GenericParam.h" 00043 #include <boost/function.hpp> 00044 #include <boost/noncopyable.hpp> 00045 #include <string> 00046 00047 namespace ompl 00048 { 00049 namespace base 00050 { 00051 00053 OMPL_CLASS_FORWARD(SpaceInformation); 00055 00057 00058 OMPL_CLASS_FORWARD(ValidStateSampler); 00060 00065 class ValidStateSampler : private boost::noncopyable 00066 { 00067 public: 00068 00070 ValidStateSampler(const SpaceInformation *si); 00071 00072 virtual ~ValidStateSampler(); 00073 00075 const std::string& getName() const 00076 { 00077 return name_; 00078 } 00079 00081 void setName(const std::string &name) 00082 { 00083 name_ = name; 00084 } 00085 00087 virtual bool sample(State *state) = 0; 00088 00091 virtual bool sampleNear(State *state, const State *near, const double distance) = 0; 00092 00096 void setNrAttempts(unsigned int attempts) 00097 { 00098 attempts_ = attempts; 00099 } 00100 00102 unsigned int getNrAttempts() const 00103 { 00104 return attempts_; 00105 } 00106 00108 ParamSet& params() 00109 { 00110 return params_; 00111 } 00112 00114 const ParamSet& params() const 00115 { 00116 return params_; 00117 } 00118 00119 protected: 00120 00122 const SpaceInformation *si_; 00123 00125 unsigned int attempts_; 00126 00128 std::string name_; 00129 00131 ParamSet params_; 00132 }; 00133 00135 typedef boost::function<ValidStateSamplerPtr(const SpaceInformation*)> ValidStateSamplerAllocator; 00136 } 00137 } 00138 00139 00140 #endif