ompl/base/PlannerStatus.h
00001 /********************************************************************* 00002 * Software License Agreement (BSD License) 00003 * 00004 * Copyright (c) 2012, 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: Mark Moll */ 00036 00037 #ifndef OMPL_BASE_PLANNER_STATUS_ 00038 #define OMPL_BASE_PLANNER_STATUS_ 00039 00040 #include <string> 00041 #include <ostream> 00042 00043 namespace ompl 00044 { 00045 namespace base 00046 { 00048 struct PlannerStatus 00049 { 00051 enum StatusType 00052 { 00054 UNKNOWN = 0, 00056 INVALID_START, 00058 INVALID_GOAL, 00060 UNRECOGNIZED_GOAL_TYPE, 00062 TIMEOUT, 00064 APPROXIMATE_SOLUTION, 00066 EXACT_SOLUTION, 00068 CRASH, 00070 TYPE_COUNT 00071 }; 00072 00074 PlannerStatus(StatusType status = UNKNOWN) : status_(status) 00075 { 00076 } 00077 00079 PlannerStatus(bool hasSolution, bool isApproximate) 00080 : status_ (hasSolution ? (isApproximate ? APPROXIMATE_SOLUTION : EXACT_SOLUTION) : TIMEOUT) 00081 { 00082 } 00083 00085 std::string asString() const; 00087 operator bool() const 00088 { 00089 return status_ == APPROXIMATE_SOLUTION || status_ == EXACT_SOLUTION; 00090 } 00092 operator StatusType() const 00093 { 00094 return status_; 00095 } 00096 00097 private: 00099 StatusType status_; 00100 }; 00101 00103 inline std::ostream& operator<<(std::ostream& out, const PlannerStatus& status) 00104 { 00105 return out << status.asString(); 00106 } 00107 } 00108 } 00109 00110 #endif