StatePropagator.h
1 /*********************************************************************
2 * Software License Agreement (BSD License)
3 *
4 * Copyright (c) 2011, Rice University
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 Rice University 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_CONTROL_STATE_PROPAGATOR_
38 #define OMPL_CONTROL_STATE_PROPAGATOR_
39 
40 #include "ompl/base/State.h"
41 #include "ompl/control/Control.h"
42 #include "ompl/util/ClassForward.h"
43 
44 namespace ompl
45 {
46  namespace control
47  {
49  OMPL_CLASS_FORWARD(SpaceInformation);
51 
53 
54  OMPL_CLASS_FORWARD(StatePropagator);
56 
61  class StatePropagator
62  {
63  public:
65  StatePropagator(SpaceInformation *si) : si_(si)
66  {
67  }
68 
70  StatePropagator(const SpaceInformationPtr &si) : si_(si.get())
71  {
72  }
73 
74  virtual ~StatePropagator() = default;
75 
92  virtual void propagate(const base::State *state, const Control *control, double duration,
93  base::State *result) const = 0;
94 
100  virtual bool canPropagateBackward() const
101  {
102  return true;
103  }
104 
112  virtual bool steer(const base::State * /*from*/, const base::State * /*to*/, Control * /*result*/,
113  double & /*duration*/) const
114  {
115  return false;
116  }
117 
119  virtual bool canSteer() const
120  {
121  return false;
122  }
123 
124  protected:
126  SpaceInformation *si_;
127  };
128  }
129 }
130 
131 #endif
A shared pointer wrapper for ompl::base::SpaceInformation.
virtual bool steer(const base::State *, const base::State *, Control *, double &) const
Compute the control that can take the system from state from to state to. Store that control in resul...
virtual void propagate(const base::State *state, const Control *control, double duration, base::State *result) const =0
Propagate from a state, given a control, for some specified amount of time (the amount of time can al...
SpaceInformation * si_
The instance of space information this state propagator operates on.
virtual bool canSteer() const
Return true if the steer() function has been implemented.
StatePropagator(SpaceInformation *si)
Constructor.
virtual bool canPropagateBackward() const
Some systems can only propagate forward in time (i.e., the duration argument for the propagate() func...
Main namespace. Contains everything in this library.
Definition: AppBase.h:21