Skip to content
GitLab
Explore
Sign in
Register
Primary navigation
Search or go to…
Project
H
hpp-manipulation
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Container Registry
Model registry
Operate
Environments
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
Humanoid Path Planner
hpp-manipulation
Commits
abcd8d55
Commit
abcd8d55
authored
5 years ago
by
Florent Lamiraux
Committed by
Florent Lamiraux florent@laas.fr
5 years ago
Browse files
Options
Downloads
Patches
Plain Diff
[doc] add doc to class WaypointEdge.
parent
0f0a5134
No related branches found
Branches containing commit
No related tags found
Tags containing commit
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
include/hpp/manipulation/graph/edge.hh
+25
-12
25 additions, 12 deletions
include/hpp/manipulation/graph/edge.hh
with
25 additions
and
12 deletions
include/hpp/manipulation/graph/edge.hh
+
25
−
12
View file @
abcd8d55
...
...
@@ -253,21 +253,34 @@ namespace hpp {
friend
class
Graph
;
};
// class Edge
/// Edge with waypoint.
/// Waypoints are handled recursively, i.e.\ class WaypointEdge contains only a
/// State and an Edge, the second Edge being itself.
/// In this package, the State in a WaypointEdge is semantically different from other State
/// because it does not correspond to a state with different manipulation rules. It has
/// the same rules as another State (either Edge::from() or Edge::to()).
/// Edge with intermediate waypoint states.
///
/// Semantically, a waypoint State is fully part of the WaypointEdge. When a corresponding path
/// reaches it, no planning is required to know what to do next. To the contrary, when a path reaches
/// Edge::from() or Edge::to(), there may be several possibilities.
/// This class implements a transition from one state to another state
/// with intermediate states in-between. This feature is particularly
/// interesting when manipulating objects. Between a state where a gripper
/// does not grasp an object and a state where the same gripper grasps
/// the object, it is useful to add an intermediate state where the
/// gripper is close to the object.
///
/// Waypoints are handled recursively, i.e.\ class WaypointEdge
/// contains only a State and an Edge, the second Edge being
/// itself. In this package, the State in a WaypointEdge is
/// semantically different from other State because it does not
/// correspond to a state with different manipulation rules. It
/// has the same rules as another State (either Edge::stateFrom() or
/// Edge::stateTo()).
///
/// Semantically, a waypoint State is fully part of the WaypointEdge.
/// When a corresponding path reaches it, no planning is required to know
/// what to do next. To the contrary, when a path reaches
/// Edge::stateFrom() or Edge::stateTo(), there may be several
/// possibilities.
///
/// \note
/// Implementation details: let's say, between the two states \f$N_f\f$ and \f$N_t\f$,
/// two waypoints are required:
/// \f$ N_f \xrightarrow{e_0} n_0 \xrightarrow{e_1} n_1 \xrightarrow{e_2} N_t\f$.
/// Implementation details: let's say, between the two states \f$N_f\f$
/// and \f$N_t\f$, two waypoints are required:
/// \f$ N_f \xrightarrow{e_0} n_0 \xrightarrow{e_1} n_1
/// \xrightarrow{e_2} N_t\f$.
/// The WaypointEdge contains:
/// \li from: \f$N_f\f$,
/// \li to: \f$N_t\f$,
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment