All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends
PathGeometric.h
1 /*********************************************************************
2 * Software License Agreement (BSD License)
3 *
4 * Copyright (c) 2008, Willow Garage, Inc.
5 * All rights reserved.
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
10 *
11 * * Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * * Redistributions in binary form must reproduce the above
14 * copyright notice, this list of conditions and the following
15 * disclaimer in the documentation and/or other materials provided
16 * with the distribution.
17 * * Neither the name of the Willow Garage nor the names of its
18 * contributors may be used to endorse or promote products derived
19 * from this software without specific prior written permission.
20 *
21 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
24 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
25 * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
26 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
27 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
28 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
29 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
31 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
32 * POSSIBILITY OF SUCH DAMAGE.
33 *********************************************************************/
34 
35 /* Author: Ioan Sucan */
36 
37 #ifndef OMPL_GEOMETRIC_PATH_GEOMETRIC_
38 #define OMPL_GEOMETRIC_PATH_GEOMETRIC_
39 
40 #include "ompl/base/SpaceInformation.h"
41 #include "ompl/base/Path.h"
42 #include <vector>
43 #include <utility>
44 
45 namespace ompl
46 {
47 
49  namespace geometric
50  {
51 
55  class PathGeometric : public base::Path
56  {
57  public:
58 
61  {
62  }
63 
65  PathGeometric(const PathGeometric &path);
66 
68  PathGeometric(const base::SpaceInformationPtr &si, const base::State *state);
69 
71  PathGeometric(const base::SpaceInformationPtr &si, const base::State *state1, const base::State *state2);
72 
73  virtual ~PathGeometric(void)
74  {
75  freeMemory();
76  }
77 
79  PathGeometric& operator=(const PathGeometric& other);
80 
82  virtual double length(void) const;
83 
84  virtual double cost(const base::OptimizationObjective &objective) const;
85 
87  virtual bool check(void) const;
88 
102  double smoothness(void) const;
103 
115  double clearance(void) const;
116 
118  virtual void print(std::ostream &out) const;
119 
120 
129  void interpolate(unsigned int count);
130 
135  void interpolate(void);
136 
138  void subdivide(void);
139 
141  void reverse(void);
142 
153  std::pair<bool, bool> checkAndRepair(unsigned int attempts);
154 
165  void overlay(const PathGeometric &over, unsigned int startIndex = 0);
166 
168  void append(const base::State *state);
169 
181  void append(const PathGeometric &path);
182 
184  void keepAfter(const base::State *state);
185 
187  void keepBefore(const base::State *state);
188 
190  void random(void);
191 
193  bool randomValid(unsigned int attempts);
200  int getClosestIndex(const base::State *state) const;
201 
203  std::vector<base::State*>& getStates(void)
204  {
205  return states_;
206  }
207 
209  base::State* getState(unsigned int index)
210  {
211  return states_[index];
212  }
213 
215  const base::State* getState(unsigned int index) const
216  {
217  return states_[index];
218  }
219 
221  std::size_t getStateCount(void) const
222  {
223  return states_.size();
224  }
225 
228  protected:
229 
231  void freeMemory(void);
232 
234  void copyFrom(const PathGeometric& other);
235 
237  std::vector<base::State*> states_;
238  };
239 
240  }
241 }
242 
243 #endif