Sophie

Sophie

distrib > Fedora > 14 > x86_64 > media > updates > by-pkgid > 727fa15453fcace956b835e2377d4269 > files > 703

player-doc-3.0.2-5.fc14.noarch.rpm

<!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&nbsp;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&nbsp;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="headertitle">
<h1>planner<br/>
<small>
[<a class="el" href="group__interfaces.html">Interface specifications</a>]</small>
</h1>  </div>
</div>
<div class="contents">

<p>A planar path-planner.  
<a href="#_details">More...</a></p>
<table class="memberdecls">
<tr><td colspan="2"><p><a class="anchor" id="amgrpd41d8cd98f00b204e9800998ecf8427e"></a> </p>
<br/><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gaba40dc3281efad94df6d727438c01f6b"></a><!-- doxytag: member="interface_planner::PLAYER_PLANNER_DATA_STATE" ref="gaba40dc3281efad94df6d727438c01f6b" args="" -->
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__interface__planner.html#gaba40dc3281efad94df6d727438c01f6b">PLAYER_PLANNER_DATA_STATE</a>&nbsp;&nbsp;&nbsp;1</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Data subtype: state. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gab43ecf96f8bf9a893b448b6bc6a06d70"></a><!-- doxytag: member="interface_planner::PLAYER_PLANNER_CMD_GOAL" ref="gab43ecf96f8bf9a893b448b6bc6a06d70" args="" -->
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__interface__planner.html#gab43ecf96f8bf9a893b448b6bc6a06d70">PLAYER_PLANNER_CMD_GOAL</a>&nbsp;&nbsp;&nbsp;1</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Command subtype: state. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga63452410f2c77f73c5e4632857ec59dd"></a><!-- doxytag: member="interface_planner::PLAYER_PLANNER_REQ_GET_WAYPOINTS" ref="ga63452410f2c77f73c5e4632857ec59dd" args="" -->
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__interface__planner.html#ga63452410f2c77f73c5e4632857ec59dd">PLAYER_PLANNER_REQ_GET_WAYPOINTS</a>&nbsp;&nbsp;&nbsp;1</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Request subtype: get waypoints. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga24584d70a5aa7faeed8b57cb325e3697"></a><!-- doxytag: member="interface_planner::PLAYER_PLANNER_REQ_ENABLE" ref="ga24584d70a5aa7faeed8b57cb325e3697" args="" -->
#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__interface__planner.html#ga24584d70a5aa7faeed8b57cb325e3697">PLAYER_PLANNER_REQ_ENABLE</a>&nbsp;&nbsp;&nbsp;2</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Request subtype: enable / disable planner. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structplayer__planner__data.html">player_planner_data</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__interface__planner.html#ga74bc508f462a48b02ddd3a0af7596fdd">player_planner_data_t</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Data: state (<a class="el" href="group__interface__planner.html#gaba40dc3281efad94df6d727438c01f6b">PLAYER_PLANNER_DATA_STATE</a>).  <a href="#ga74bc508f462a48b02ddd3a0af7596fdd"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structplayer__planner__cmd.html">player_planner_cmd</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__interface__planner.html#ga3ddf2fcd6bcc1e1294e11636ba196f07">player_planner_cmd_t</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Command: state (<a class="el" href="group__interface__planner.html#gab43ecf96f8bf9a893b448b6bc6a06d70">PLAYER_PLANNER_CMD_GOAL</a>).  <a href="#ga3ddf2fcd6bcc1e1294e11636ba196f07"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef struct <br class="typebreak"/>
<a class="el" href="structplayer__planner__waypoints__req.html">player_planner_waypoints_req</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__interface__planner.html#gab14478a9518c51784560176de1587d49">player_planner_waypoints_req_t</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Request/reply: Get waypoints.  <a href="#gab14478a9518c51784560176de1587d49"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef struct <br class="typebreak"/>
<a class="el" href="structplayer__planner__enable__req.html">player_planner_enable_req</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__interface__planner.html#ga81639cc969d379954d0c4a2734d47d76">player_planner_enable_req_t</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Request/reply: Enable/disable robot motion.  <a href="#ga81639cc969d379954d0c4a2734d47d76"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>A planar path-planner. </p>
<p>The <code>planner</code> interface provides control of a 2-D motion planner. </p>
<hr/><h2>Typedef Documentation</h2>
<a class="anchor" id="ga3ddf2fcd6bcc1e1294e11636ba196f07"></a><!-- doxytag: member="player_interfaces.h::player_planner_cmd_t" ref="ga3ddf2fcd6bcc1e1294e11636ba196f07" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef struct <a class="el" href="structplayer__planner__cmd.html">player_planner_cmd</a>  <a class="el" href="structplayer__planner__cmd.html">player_planner_cmd_t</a></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Command: state (<a class="el" href="group__interface__planner.html#gab43ecf96f8bf9a893b448b6bc6a06d70">PLAYER_PLANNER_CMD_GOAL</a>). </p>
<p>The <code>planner</code> interface accepts a new goal. </p>

</div>
</div>
<a class="anchor" id="ga74bc508f462a48b02ddd3a0af7596fdd"></a><!-- doxytag: member="player_interfaces.h::player_planner_data_t" ref="ga74bc508f462a48b02ddd3a0af7596fdd" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef struct <a class="el" href="structplayer__planner__data.html">player_planner_data</a>  <a class="el" href="structplayer__planner__data.html">player_planner_data_t</a></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Data: state (<a class="el" href="group__interface__planner.html#gaba40dc3281efad94df6d727438c01f6b">PLAYER_PLANNER_DATA_STATE</a>). </p>
<p>The <code>planner</code> interface reports the current execution state of the planner. </p>

</div>
</div>
<a class="anchor" id="ga81639cc969d379954d0c4a2734d47d76"></a><!-- doxytag: member="player_interfaces.h::player_planner_enable_req_t" ref="ga81639cc969d379954d0c4a2734d47d76" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef struct <a class="el" href="structplayer__planner__enable__req.html">player_planner_enable_req</a>  <a class="el" href="structplayer__planner__enable__req.html">player_planner_enable_req_t</a></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Request/reply: Enable/disable robot motion. </p>
<p>To enable or disable the planner, send a <a class="el" href="group__interface__planner.html#ga24584d70a5aa7faeed8b57cb325e3697">PLAYER_PLANNER_REQ_ENABLE</a> request. When disabled, the planner will stop the robot. When enabled, the planner should resume plan execution. Null response. </p>

</div>
</div>
<a class="anchor" id="gab14478a9518c51784560176de1587d49"></a><!-- doxytag: member="player_interfaces.h::player_planner_waypoints_req_t" ref="gab14478a9518c51784560176de1587d49" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef struct <a class="el" href="structplayer__planner__waypoints__req.html">player_planner_waypoints_req</a>  <a class="el" href="structplayer__planner__waypoints__req.html">player_planner_waypoints_req_t</a></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Request/reply: Get waypoints. </p>
<p>To retrieve the list of waypoints, send a null <a class="el" href="group__interface__planner.html#ga63452410f2c77f73c5e4632857ec59dd">PLAYER_PLANNER_REQ_GET_WAYPOINTS</a> request. </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>

Perl :: Catalyst :: PostgreSQL :: RPM Valid HTML 4.01 Transitional