Robotics Library  0.7.0
Planner.h
Go to the documentation of this file.
1 //
2 // Copyright (c) 2009, Markus Rickert
3 // All rights reserved.
4 //
5 // Redistribution and use in source and binary forms, with or without
6 // modification, are permitted provided that the following conditions are met:
7 //
8 // * Redistributions of source code must retain the above copyright notice,
9 // this list of conditions and the following disclaimer.
10 // * Redistributions in binary form must reproduce the above copyright notice,
11 // this list of conditions and the following disclaimer in the documentation
12 // and/or other materials provided with the distribution.
13 //
14 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
15 // AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 // ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
18 // LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
19 // CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
20 // SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
21 // INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
22 // CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
23 // ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
24 // POSSIBILITY OF SUCH DAMAGE.
25 //
26 
27 #ifndef RL_PLAN_PLANNER_H
28 #define RL_PLAN_PLANNER_H
29 
30 #include <chrono>
31 #include <string>
32 #include <rl/math/Vector.h>
33 
34 #include "VectorList.h"
35 
36 namespace rl
37 {
41  namespace plan
42  {
43  class SimpleModel;
44  class Viewer;
45 
46  class Planner
47  {
48  public:
49  Planner();
50 
51  virtual ~Planner();
52 
53  virtual ::std::string getName() const = 0;
54 
60  virtual VectorList getPath() = 0;
61 
65  virtual void reset() = 0;
66 
70  virtual bool solve() = 0;
71 
75  bool verify();
76 
78  ::std::chrono::steady_clock::duration duration;
79 
82 
84 
87 
89 
90  protected:
91  ::std::chrono::steady_clock::time_point time;
92 
93  private:
94 
95  };
96  }
97 }
98 
99 #endif // RL_PLAN_PLANNER_H
rl::plan::Planner::start
::rl::math::Vector * start
Start configuration.
Definition: Planner.h:86
VectorList.h
rl::plan::Planner::solve
virtual bool solve()=0
Find collision free path.
rl::plan::Planner::model
SimpleModel * model
Definition: Planner.h:83
rl::plan::VectorList
::std::list< ::rl::math::Vector > VectorList
Definition: VectorList.h:37
rl::plan::Planner::reset
virtual void reset()=0
Reset planner.
rl::math::Vector
::Eigen::Matrix< Real, ::Eigen::Dynamic, 1 > Vector
Definition: Vector.h:42
rl::plan::Planner::goal
::rl::math::Vector * goal
Goal configuration.
Definition: Planner.h:81
Vector.h
rl::plan::Planner
Definition: Planner.h:47
rl::plan::SimpleModel
Definition: SimpleModel.h:37
rl::plan::Planner::getName
virtual ::std::string getName() const =0
rl::plan::Planner::~Planner
virtual ~Planner()
Definition: Planner.cpp:45
rl::plan::Planner::viewer
Viewer * viewer
Definition: Planner.h:88
rl::plan::Planner::getPath
virtual VectorList getPath()=0
Get solution path.
rl::plan::Planner::verify
bool verify()
Vertify that start and goal configuration are within joint limits and collision free.
Definition: Planner.cpp:50
rl::plan::Planner::duration
::std::chrono::steady_clock::duration duration
Upper bound for search.
Definition: Planner.h:78
rl::plan::Planner::Planner
Planner()
Definition: Planner.cpp:35
rl::plan::Planner::time
::std::chrono::steady_clock::time_point time
Definition: Planner.h:91
rl::plan::Viewer
Definition: Viewer.h:40
rl
Robotics Library.
Definition: AnalogInput.cpp:30