-
Notifications
You must be signed in to change notification settings - Fork 162
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Deploy frankaemika/libfranka to github.com/frankaemika/libfranka.git:…
…gh-pages
- Loading branch information
0 parents
commit a86d0c2
Showing
593 changed files
with
30,063 additions
and
0 deletions.
There are no files selected for viewing
Empty file.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,115 @@ | ||
| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> | ||
| <html xmlns="http://www.w3.org/1999/xhtml"> | ||
| <head> | ||
| <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> | ||
| <meta http-equiv="X-UA-Compatible" content="IE=9"/> | ||
| <meta name="generator" content="Doxygen 1.8.13"/> | ||
| <meta name="viewport" content="width=device-width, initial-scale=1"/> | ||
| <title>libfranka: Class List</title> | ||
| <link href="tabs.css" rel="stylesheet" type="text/css"/> | ||
| <script type="text/javascript" src="jquery.js"></script> | ||
| <script type="text/javascript" src="dynsections.js"></script> | ||
| <link href="search/search.css" rel="stylesheet" type="text/css"/> | ||
| <script type="text/javascript" src="search/searchdata.js"></script> | ||
| <script type="text/javascript" src="search/search.js"></script> | ||
| <script type="text/x-mathjax-config"> | ||
| MathJax.Hub.Config({ | ||
| extensions: ["tex2jax.js"], | ||
| jax: ["input/TeX","output/SVG"], | ||
| }); | ||
| </script><script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js"></script> | ||
| <link href="doxygen.css" rel="stylesheet" type="text/css" /> | ||
| </head> | ||
| <body> | ||
| <div id="top"><!-- do not remove this div, it is closed by doxygen! --> | ||
| <div id="titlearea"> | ||
| <table cellspacing="0" cellpadding="0"> | ||
| <tbody> | ||
| <tr style="height: 56px;"> | ||
| <td id="projectlogo"><img alt="Logo" src="Logo_FRANKA_EMIKA_dark.png"/></td> | ||
| <td id="projectalign" style="padding-left: 0.5em;"> | ||
| <div id="projectname">libfranka | ||
|  <span id="projectnumber">0.8.0</span> | ||
| </div> | ||
| <div id="projectbrief">FCI C++ API</div> | ||
| </td> | ||
| </tr> | ||
| </tbody> | ||
| </table> | ||
| </div> | ||
| <!-- end header part --> | ||
| <!-- Generated by Doxygen 1.8.13 --> | ||
| <script type="text/javascript"> | ||
| var searchBox = new SearchBox("searchBox", "search",false,'Search'); | ||
| </script> | ||
| <script type="text/javascript" src="menudata.js"></script> | ||
| <script type="text/javascript" src="menu.js"></script> | ||
| <script type="text/javascript"> | ||
| $(function() { | ||
| initMenu('',true,false,'search.php','Search'); | ||
| $(document).ready(function() { init_search(); }); | ||
| }); | ||
| </script> | ||
| <div id="main-nav"></div> | ||
| </div><!-- top --> | ||
| <!-- window showing the filter options --> | ||
| <div id="MSearchSelectWindow" | ||
| onmouseover="return searchBox.OnSearchSelectShow()" | ||
| onmouseout="return searchBox.OnSearchSelectHide()" | ||
| onkeydown="return searchBox.OnSearchSelectKey(event)"> | ||
| </div> | ||
|
|
||
| <!-- iframe showing the search results (closed by default) --> | ||
| <div id="MSearchResultsWindow"> | ||
| <iframe src="javascript:void(0)" frameborder="0" | ||
| name="MSearchResults" id="MSearchResults"> | ||
| </iframe> | ||
| </div> | ||
|
|
||
| <div class="header"> | ||
| <div class="headertitle"> | ||
| <div class="title">Class List</div> </div> | ||
| </div><!--header--> | ||
| <div class="contents"> | ||
| <div class="textblock">Here are the classes, structs, unions and interfaces with brief descriptions:</div><div class="directory"> | ||
| <div class="levels">[detail level <span onclick="javascript:toggleLevel(1);">1</span><span onclick="javascript:toggleLevel(2);">2</span>]</div><table class="directory"> | ||
| <tr id="row_0_" class="even"><td class="entry"><span style="width:0px;display:inline-block;"> </span><span id="arr_0_" class="arrow" onclick="toggleFolder('0_')">▼</span><span class="icona"><span class="icon">N</span></span><b>franka</b></td><td class="desc"></td></tr> | ||
| <tr id="row_0_0_"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classfranka_1_1CartesianPose.html" target="_self">CartesianPose</a></td><td class="desc">Stores values for Cartesian pose motion generation </td></tr> | ||
| <tr id="row_0_1_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classfranka_1_1CartesianVelocities.html" target="_self">CartesianVelocities</a></td><td class="desc">Stores values for Cartesian velocity motion generation </td></tr> | ||
| <tr id="row_0_2_"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="structfranka_1_1CommandException.html" target="_self">CommandException</a></td><td class="desc"><a class="el" href="structfranka_1_1CommandException.html" title="CommandException is thrown if an error occurs during command execution. ">CommandException</a> is thrown if an error occurs during command execution </td></tr> | ||
| <tr id="row_0_3_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="structfranka_1_1ControlException.html" target="_self">ControlException</a></td><td class="desc"><a class="el" href="structfranka_1_1ControlException.html" title="ControlException is thrown if an error occurs during motion generation or torque control. ">ControlException</a> is thrown if an error occurs during motion generation or torque control </td></tr> | ||
| <tr id="row_0_4_"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classfranka_1_1Duration.html" target="_self">Duration</a></td><td class="desc">Represents a duration with millisecond resolution </td></tr> | ||
| <tr id="row_0_5_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="structfranka_1_1Errors.html" target="_self">Errors</a></td><td class="desc">Enumerates errors that can occur while controlling a <a class="el" href="classfranka_1_1Robot.html" title="Maintains a network connection to the robot, provides the current robot state, gives access to the mo...">franka::Robot</a> </td></tr> | ||
| <tr id="row_0_6_"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="structfranka_1_1Exception.html" target="_self">Exception</a></td><td class="desc">Base class for all exceptions used by <code>libfranka</code> </td></tr> | ||
| <tr id="row_0_7_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="structfranka_1_1Finishable.html" target="_self">Finishable</a></td><td class="desc">Helper type for control and motion generation loops </td></tr> | ||
| <tr id="row_0_8_"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classfranka_1_1Gripper.html" target="_self">Gripper</a></td><td class="desc">Maintains a network connection to the gripper, provides the current gripper state, and allows the execution of commands </td></tr> | ||
| <tr id="row_0_9_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="structfranka_1_1GripperState.html" target="_self">GripperState</a></td><td class="desc">Describes the gripper state </td></tr> | ||
| <tr id="row_0_10_"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="structfranka_1_1IncompatibleVersionException.html" target="_self">IncompatibleVersionException</a></td><td class="desc"><a class="el" href="structfranka_1_1IncompatibleVersionException.html" title="IncompatibleVersionException is thrown if the robot does not support this version of libfranka...">IncompatibleVersionException</a> is thrown if the robot does not support this version of libfranka </td></tr> | ||
| <tr id="row_0_11_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="structfranka_1_1InvalidOperationException.html" target="_self">InvalidOperationException</a></td><td class="desc"><a class="el" href="structfranka_1_1InvalidOperationException.html" title="InvalidOperationException is thrown if an operation cannot be performed. ">InvalidOperationException</a> is thrown if an operation cannot be performed </td></tr> | ||
| <tr id="row_0_12_"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classfranka_1_1JointPositions.html" target="_self">JointPositions</a></td><td class="desc">Stores values for joint position motion generation </td></tr> | ||
| <tr id="row_0_13_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classfranka_1_1JointVelocities.html" target="_self">JointVelocities</a></td><td class="desc">Stores values for joint velocity motion generation </td></tr> | ||
| <tr id="row_0_14_"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classfranka_1_1Model.html" target="_self">Model</a></td><td class="desc">Calculates poses of joints and dynamic properties of the robot </td></tr> | ||
| <tr id="row_0_15_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="structfranka_1_1ModelException.html" target="_self">ModelException</a></td><td class="desc"><a class="el" href="structfranka_1_1ModelException.html" title="ModelException is thrown if an error occurs when loading the model library. ">ModelException</a> is thrown if an error occurs when loading the model library </td></tr> | ||
| <tr id="row_0_16_"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="structfranka_1_1NetworkException.html" target="_self">NetworkException</a></td><td class="desc"><a class="el" href="structfranka_1_1NetworkException.html" title="NetworkException is thrown if a connection to the robot cannot be established, or when a timeout occu...">NetworkException</a> is thrown if a connection to the robot cannot be established, or when a timeout occurs </td></tr> | ||
| <tr id="row_0_17_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="structfranka_1_1ProtocolException.html" target="_self">ProtocolException</a></td><td class="desc"><a class="el" href="structfranka_1_1ProtocolException.html" title="ProtocolException is thrown if the robot returns an incorrect message. ">ProtocolException</a> is thrown if the robot returns an incorrect message </td></tr> | ||
| <tr id="row_0_18_"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="structfranka_1_1RealtimeException.html" target="_self">RealtimeException</a></td><td class="desc"><a class="el" href="structfranka_1_1RealtimeException.html" title="RealtimeException is thrown if realtime priority cannot be set. ">RealtimeException</a> is thrown if realtime priority cannot be set </td></tr> | ||
| <tr id="row_0_19_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="structfranka_1_1Record.html" target="_self">Record</a></td><td class="desc">One row of the log contains a robot command of timestamp n and a corresponding robot state of timestamp n+1 </td></tr> | ||
| <tr id="row_0_20_"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classfranka_1_1Robot.html" target="_self">Robot</a></td><td class="desc">Maintains a network connection to the robot, provides the current robot state, gives access to the model library and allows to control the robot </td></tr> | ||
| <tr id="row_0_21_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="structfranka_1_1RobotCommand.html" target="_self">RobotCommand</a></td><td class="desc">Command sent to the robot </td></tr> | ||
| <tr id="row_0_22_"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="structfranka_1_1RobotState.html" target="_self">RobotState</a></td><td class="desc">Describes the robot state </td></tr> | ||
| <tr id="row_0_23_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classfranka_1_1Torques.html" target="_self">Torques</a></td><td class="desc">Stores joint-level torque commands without gravity and friction </td></tr> | ||
| <tr id="row_0_24_"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classfranka_1_1VacuumGripper.html" target="_self">VacuumGripper</a></td><td class="desc">Maintains a network connection to the vacuum gripper, provides the current vacuum gripper state, and allows the execution of commands </td></tr> | ||
| <tr id="row_0_25_" class="even"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="structfranka_1_1VacuumGripperState.html" target="_self">VacuumGripperState</a></td><td class="desc">Describes the vacuum gripper state </td></tr> | ||
| <tr id="row_0_26_"><td class="entry"><span style="width:32px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="structfranka_1_1VirtualWallCuboid.html" target="_self">VirtualWallCuboid</a></td><td class="desc">Parameters of a cuboid used as virtual wall </td></tr> | ||
| <tr id="row_1_" class="even"><td class="entry"><span style="width:16px;display:inline-block;"> </span><span class="icona"><span class="icon">C</span></span><a class="el" href="classMotionGenerator.html" target="_self">MotionGenerator</a></td><td class="desc">An example showing how to generate a joint pose motion to a goal position </td></tr> | ||
| </table> | ||
| </div><!-- directory --> | ||
| </div><!-- contents --> | ||
| <!-- start footer part --> | ||
| <hr class="footer"/><address class="footer"><small> | ||
| Generated by  <a href="http://www.doxygen.org/index.html"> | ||
| <img class="footer" src="doxygen.png" alt="doxygen"/> | ||
| </a> 1.8.13 | ||
| </small></address> | ||
| </body> | ||
| </html> |
Oops, something went wrong.