ompl/base/PlannerTerminationCondition.h
00001 /********************************************************************* 00002 * Software License Agreement (BSD License) 00003 * 00004 * Copyright (c) 2011, 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_PLANNER_TERMINATION_CONDITION_ 00038 #define OMPL_BASE_PLANNER_TERMINATION_CONDITION_ 00039 00040 #include <boost/function.hpp> 00041 #include <boost/shared_ptr.hpp> 00042 00043 namespace ompl 00044 { 00045 00046 namespace base 00047 { 00048 00056 typedef boost::function<bool()> PlannerTerminationConditionFn; 00057 00064 class PlannerTerminationCondition 00065 { 00066 public: 00067 00070 PlannerTerminationCondition(const PlannerTerminationConditionFn &fn); 00071 00075 PlannerTerminationCondition(const PlannerTerminationConditionFn &fn, double period); 00076 00077 ~PlannerTerminationCondition() 00078 { 00079 } 00080 00082 bool operator()() const 00083 { 00084 return eval(); 00085 } 00086 00088 operator bool() const 00089 { 00090 return eval(); 00091 } 00092 00095 void terminate() const; 00096 00098 bool eval() const; 00099 00100 private: 00101 00102 class PlannerTerminationConditionImpl; 00103 boost::shared_ptr<PlannerTerminationConditionImpl> impl_; 00104 }; 00105 00107 PlannerTerminationCondition plannerNonTerminatingCondition(); 00108 00110 PlannerTerminationCondition plannerAlwaysTerminatingCondition(); 00111 00113 PlannerTerminationCondition plannerOrTerminationCondition(const PlannerTerminationCondition &c1, const PlannerTerminationCondition &c2); 00114 00116 PlannerTerminationCondition plannerAndTerminationCondition(const PlannerTerminationCondition &c1, const PlannerTerminationCondition &c2); 00117 00119 PlannerTerminationCondition timedPlannerTerminationCondition(double duration); 00120 00122 PlannerTerminationCondition timedPlannerTerminationCondition(double duration, double interval); 00123 } 00124 } 00125 00126 #endif