<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"> <html> <!-- $Id: header.html 8799 2010-06-28 04:12:42Z jpgr87 $ --> <HEAD> <meta HTTP-EQUIV="Content-Type" CONTENT="text/html;CHARSET=utf-8"> <meta name="keywords" content="stage, robot, simulation, player, player/stage"> <link href="doxygen.css" rel="stylesheet" type="text/css"> <style type="text/css"> .floatright { float: right; margin: 0 0 1em 1em; } body { font-family: sans-serif; #font-family: Geneva, Verdana, Helvetica, Arial, sans-serif; background-color: #FFF; color:#000; } a:link { color: #A00; } a:visited { color: #800; } a { text-decoration: none; } a:hover { text-decoration: underline; } .timestamp { text-align:right; background-color: #DDD; font-size:75%;} h1 { font-size:160%; } h2 { font-size:110%; #color: #FFF; #background-color: #666; #padding:3px; } h3 { text-align:left; } img { border: 0; } ul.menu { position:relative; left:-2.5em; margin-bottom:0px; margin-top:0px; } ul.menu1 { position:relative; left:-2.1em; margin-bottom:0px; margin-top:0px; } li.menu { list-style-type: none; position:relative; #left:-0.5em; } #sidebar { position: absolute; left:0px; padding:2em; top:0em; width:12em;} #content { position: absolute; left:12em; top:0em; padding-left:3em; padding-right:3em; padding-bottom:2em; margin-top:1em; margin-right:2em; } div.box { background-color:#EEE; border: 1px solid #000; padding: 0.5ex 0.4em 0.5ex 0.6em; margin:1em; } div.title { font-weight:bold; background-color:#eee; margin-bottom:2px;} div.topbar { position: absolute; top:0px; left:9em; margin:1em; } </style> <TITLE>Player Manual</TITLE> </HEAD> <body> <div id="sidebar"> <h2 style="text-align:center;"> <a href="index.html"> <img width=140 src="http://playerstage.sourceforge.net/images/player_button_v3.png" alt="Player logo"><br></a> </h2> <div class="box"> <div class=title>Player</div> <ul class=menu> <li class=menu><a href="index.html">Frontpage</a> <li class=menu><a href="modules.html">Contents</a> </ul> </div> <div class="box"> <div class=title>User</div> <ul class=menu> <li class=menu><a href="install.html">Installation</a> <li class=menu><a href="start.html">Quick start</a> <li class=menu><a href="supported_hardware.html">Supported devices</a> <li class=menu><a href="group__tutorials.html">Tutorials</a> <li class=menu><a href="group__utils.html">Utilities</a> <li class=menu><a href="group__clientlibs.html">Client libraries</a> <li class=menu><a href="http://playerstage.sourceforge.net/wiki/Basic_FAQ">FAQ</a> <li class=menu><a href="help.html">Help</a> </ul> </div> <div class=box> <div class="title">Developer</div> <ul class=menu> <li class=menu><a href="architecture.html">Architecture</a> <li class=menu><a href="group__libplayercore.html">libplayercore</a> <ul class=menu1> <li class=menu><a href="group__interfaces.html">interfaces</a></li> </ul> <li class=menu><a href="group__libplayerdrivers.html">libplayerdrivers</a> <ul class=menu1> <li class=menu><a href="group__drivers.html">drivers</a></li> </ul> <li class=menu><a href="group__libplayercommon.html">libplayercommon</a> <li class=menu><a href="group__libplayerutils.html">libplayerutils</a> <li class=menu><a href="group__libplayersd.html">libplayersd</a> <li class=menu><a href="group__libplayertcp.html">libplayertcp</a> <li class=menu><a href="group__libplayerxdr.html">libplayerxdr</a> <li class=menu><a href="todo.html">TODO</a> </ul> </div> <div class=box> <!-- <a href="http://sourceforge.net"><img border=0 src="http://sourceforge.net/sflogo.php?group_id=42445&type=1"></a> --> <div class="title">Online</div> <a href="http://playerstage.sourceforge.net">Homepage</a><br> <a href="http://sourceforge.net/project/showfiles.php?group_id=42445">Download</a><br> <a href="http://sourceforge.net/projects/playerstage">Project</a><br> <a href="http://sourceforge.net/tracker/?group_id=42445">Bugs</a><br> <a href="http://sourceforge.net/mail/?group_id=42445">Help</a> </div> </div> <div id="content" > <!-- Generated by Doxygen 1.7.1 --> <div class="header"> <div class="summary"> <a href="#nested-classes">Classes</a> | <a href="#func-members">Functions</a> </div> <div class="headertitle"> <h1>planner<br/> <small> [<a class="el" href="group__playerc__proxies.html">Device proxies</a>]</small> </h1> </div> </div> <div class="contents"> <p>The planner proxy provides an interface to a 2D motion planner. <a href="#_details">More...</a></p> <table class="memberdecls"> <tr><td colspan="2"><h2><a name="nested-classes"></a> Classes</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structplayerc__planner__t.html">playerc_planner_t</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Planner device data. <a href="structplayerc__planner__t.html#_details">More...</a><br/></td></tr> <tr><td colspan="2"><h2><a name="func-members"></a> Functions</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top">PLAYERC_EXPORT <a class="el" href="structplayerc__planner__t.html">playerc_planner_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__playerc__proxy__planner.html#ga0bbc404671ad6c4eeeec15c70c733cfc">playerc_planner_create</a> (<a class="el" href="struct__playerc__client__t.html">playerc_client_t</a> *client, int index)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Create a planner device proxy. <a href="#ga0bbc404671ad6c4eeeec15c70c733cfc"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">PLAYERC_EXPORT void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__playerc__proxy__planner.html#ga74ce82ca05e49968c4887f6c55ea64f7">playerc_planner_destroy</a> (<a class="el" href="structplayerc__planner__t.html">playerc_planner_t</a> *device)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Destroy a planner device proxy. <a href="#ga74ce82ca05e49968c4887f6c55ea64f7"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga6c0218be82af5dbd8467c34afefa7ee0"></a><!-- doxytag: member="playerc_proxy_planner::playerc_planner_subscribe" ref="ga6c0218be82af5dbd8467c34afefa7ee0" args="(playerc_planner_t *device, int access)" --> PLAYERC_EXPORT int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__playerc__proxy__planner.html#ga6c0218be82af5dbd8467c34afefa7ee0">playerc_planner_subscribe</a> (<a class="el" href="structplayerc__planner__t.html">playerc_planner_t</a> *device, int access)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Subscribe to the planner device. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gad465818f905dbf663b6d9640375abcfc"></a><!-- doxytag: member="playerc_proxy_planner::playerc_planner_unsubscribe" ref="gad465818f905dbf663b6d9640375abcfc" args="(playerc_planner_t *device)" --> PLAYERC_EXPORT int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__playerc__proxy__planner.html#gad465818f905dbf663b6d9640375abcfc">playerc_planner_unsubscribe</a> (<a class="el" href="structplayerc__planner__t.html">playerc_planner_t</a> *device)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Un-subscribe from the planner device. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga9e15eaf0fc7fa6a2d7c5b9c70d200826"></a><!-- doxytag: member="playerc_proxy_planner::playerc_planner_set_cmd_pose" ref="ga9e15eaf0fc7fa6a2d7c5b9c70d200826" args="(playerc_planner_t *device, double gx, double gy, double ga)" --> PLAYERC_EXPORT int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__playerc__proxy__planner.html#ga9e15eaf0fc7fa6a2d7c5b9c70d200826">playerc_planner_set_cmd_pose</a> (<a class="el" href="structplayerc__planner__t.html">playerc_planner_t</a> *device, double gx, double gy, double ga)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Set the goal pose (gx, gy, ga). <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">PLAYERC_EXPORT int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__playerc__proxy__planner.html#ga3b8605185dc16af52d3cf7f1c4b30abe">playerc_planner_get_waypoints</a> (<a class="el" href="structplayerc__planner__t.html">playerc_planner_t</a> *device)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the list of waypoints. <a href="#ga3b8605185dc16af52d3cf7f1c4b30abe"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">PLAYERC_EXPORT int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__playerc__proxy__planner.html#ga3422cf4d2da29cbbc9ae0aa35f65fa6c">playerc_planner_enable</a> (<a class="el" href="structplayerc__planner__t.html">playerc_planner_t</a> *device, int state)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Enable / disable the robot's motion. <a href="#ga3422cf4d2da29cbbc9ae0aa35f65fa6c"></a><br/></td></tr> </table> <hr/><a name="_details"></a><h2>Detailed Description</h2> <p>The planner proxy provides an interface to a 2D motion planner. </p> <hr/><h2>Function Documentation</h2> <a class="anchor" id="ga0bbc404671ad6c4eeeec15c70c733cfc"></a><!-- doxytag: member="playerc.h::playerc_planner_create" ref="ga0bbc404671ad6c4eeeec15c70c733cfc" args="(playerc_client_t *client, int index)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">PLAYERC_EXPORT <a class="el" href="structplayerc__planner__t.html">playerc_planner_t</a>* playerc_planner_create </td> <td>(</td> <td class="paramtype"><a class="el" href="struct__playerc__client__t.html">playerc_client_t</a> * </td> <td class="paramname"> <em>client</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int </td> <td class="paramname"> <em>index</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td></td> </tr> </table> </div> <div class="memdoc"> <p>Create a planner device proxy. </p> </div> </div> <a class="anchor" id="ga74ce82ca05e49968c4887f6c55ea64f7"></a><!-- doxytag: member="playerc.h::playerc_planner_destroy" ref="ga74ce82ca05e49968c4887f6c55ea64f7" args="(playerc_planner_t *device)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">PLAYERC_EXPORT void playerc_planner_destroy </td> <td>(</td> <td class="paramtype"><a class="el" href="structplayerc__planner__t.html">playerc_planner_t</a> * </td> <td class="paramname"> <em>device</em></td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>Destroy a planner device proxy. </p> </div> </div> <a class="anchor" id="ga3422cf4d2da29cbbc9ae0aa35f65fa6c"></a><!-- doxytag: member="playerc.h::playerc_planner_enable" ref="ga3422cf4d2da29cbbc9ae0aa35f65fa6c" args="(playerc_planner_t *device, int state)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">PLAYERC_EXPORT int playerc_planner_enable </td> <td>(</td> <td class="paramtype"><a class="el" href="structplayerc__planner__t.html">playerc_planner_t</a> * </td> <td class="paramname"> <em>device</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int </td> <td class="paramname"> <em>state</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td></td> </tr> </table> </div> <div class="memdoc"> <p>Enable / disable the robot's motion. </p> <p>Set state to 1 to enable, 0 to disable. </p> </div> </div> <a class="anchor" id="ga3b8605185dc16af52d3cf7f1c4b30abe"></a><!-- doxytag: member="playerc.h::playerc_planner_get_waypoints" ref="ga3b8605185dc16af52d3cf7f1c4b30abe" args="(playerc_planner_t *device)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">PLAYERC_EXPORT int playerc_planner_get_waypoints </td> <td>(</td> <td class="paramtype"><a class="el" href="structplayerc__planner__t.html">playerc_planner_t</a> * </td> <td class="paramname"> <em>device</em></td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>Get the list of waypoints. </p> <p>Writes the result into the proxy rather than returning it to the caller. </p> </div> </div> </div> <!-- render the modification time of the source file --> <div class="timestamp"> <hr> <table style="width:100%;"> <tr> <td style="text-align:left;"> Last updated 12 September 2005 21:38:45 <!-- <td style="text-align:right;"> <a href="http://validator.w3.org/check/referer"><img style="vertical-align:middle;border:0;width:88px;height:31px" src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!"></a> <a href="http://jigsaw.w3.org/css-validator/"> <img style="vertical-align:middle;border:0;width:88px;height:31px" src="http://jigsaw.w3.org/css-validator/images/vcss" alt="Valid CSS!"> </a> --> </tr> </table> </div> </tr> </table> </BODY> </HTML>