Skip to content
GitLab
Menu
Projects
Groups
Snippets
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
Menu
Open sidebar
Stack Of Tasks
sot-dynamic-pinocchio
Commits
46756302
Commit
46756302
authored
Dec 28, 2010
by
florent
Browse files
Fix generation of sphinx documentation.
* doc/sphinx/index.rst.in, * src/dynamic.cpp.
parent
9ec03e46
Changes
2
Hide whitespace changes
Inline
Side-by-side
doc/sphinx/index.rst.in
View file @
46756302
...
...
@@ -3,7 +3,7 @@
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to
sot-dynamic documentation
!
sot-dynamic
: python bindings
documentation
================================================
.. toctree::
...
...
@@ -13,6 +13,8 @@ Python module dynamic_graph.sot.dynamics implements bindings for sot-dynamic_ li
Entities
--------
.. automodule:: dynamic_graph.sot.dynamics
:members:
.. autoclass:: dynamic_graph.sot.dynamics.dynamic.Dynamic
:members:
...
...
src/dynamic.cpp
View file @
46756302
...
...
@@ -155,11 +155,12 @@ Dynamic( const std::string & name, bool build )
"
\n
"
" Define files to parse in order to build the robot.
\n
"
"
\n
"
" Takes as input 4 string:
\n
"
" - Directory containing main wrl file,
\n
"
" - name of wrl file,
\n
"
" - xml file containing humanoid specificities,
\n
"
" - xml file defining order of joints in configuration vector.
\n
"
" Input:
\n
"
" - a string: directory containing main wrl file,
\n
"
" - a string: name of wrl file,
\n
"
" - a string: xml file containing humanoid specificities,
\n
"
" - a string: xml file defining order of joints in configuration"
" vector.
\n
"
"
\n
"
;
addCommand
(
"setFiles"
,
new
command
::
SetFiles
(
*
this
,
docstring
));
...
...
@@ -168,7 +169,7 @@ Dynamic( const std::string & name, bool build )
"
\n
"
" Parse files to build an instance ot robot.
\n
"
"
\n
"
"
Takes no argumen
t.
\n
"
"
No inpu
t.
\n
"
" Files are defined by command setFiles
\n
"
"
\n
"
;
addCommand
(
"parse"
,
...
...
@@ -178,7 +179,7 @@ Dynamic( const std::string & name, bool build )
docstring
=
"
\n
"
" Create an operational point attached to a robot joint local frame.
\n
"
"
\n
"
"
Takes 2 arguments
:
\n
"
"
Input
:
\n
"
" - a string: name of the operational point,
\n
"
" - a string: name the joint, among (gaze, left-ankle, right ankle
\n
"
" , left-wrist, right-wrist, waist, chest).
\n
"
...
...
@@ -189,7 +190,7 @@ Dynamic( const std::string & name, bool build )
docstring
=
"
\n
"
" Set a property.
\n
"
"
\n
"
"
Takes 2 arguments
:
\n
"
"
Input
:
\n
"
" - a string: name of the property,
\n
"
" - a string: value of the property.
\n
"
"
\n
"
;
...
...
@@ -215,7 +216,7 @@ Dynamic( const std::string & name, bool build )
" Input:
\n
"
" - a string: name of the joint,
\n
"
" - a string: type of the joint in ['freeflyer', 'rotation',
\n
"
"
'
translation', 'anchor'],
\n
"
"
'
translation', 'anchor'],
\n
"
" - a matrix: (homogeneous) position of the joint.
\n
"
"
\n
"
;
addCommand
(
"createJoint"
,
new
command
::
CreateJoint
(
*
this
,
docstring
));
...
...
Write
Preview
Supports
Markdown
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment