Sophie

Sophie

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

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="summary">
<a href="#pub-attribs">Public Attributes</a>  </div>
  <div class="headertitle">
<h1>playerc_position1d_t Struct Reference<br/>
<small>
[<a class="el" href="group__playerc__proxy__position1d.html">position1d</a>]</small>
</h1>  </div>
</div>
<div class="contents">
<!-- doxytag: class="playerc_position1d_t" -->
<p>Position1d device data.  
<a href="#_details">More...</a></p>

<p><code>#include &lt;<a class="el" href="playerc_8h_source.html">playerc.h</a>&gt;</code></p>

<p><a href="structplayerc__position1d__t-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct__playerc__device__t.html">playerc_device_t</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structplayerc__position1d__t.html#af01a5d198961df625356028d537e1dfe">info</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight"><a class="el" href="classDevice.html" title="Encapsulates a device (i.e., a driver bound to an interface).">Device</a> info; must be at the start of all device structures.  <a href="#af01a5d198961df625356028d537e1dfe"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structplayerc__position1d__t.html#afd1ecbed76a06e722f60fc2263f606e8">pose</a> [3]</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Robot geometry in robot cs: pose gives the position1d and orientation, size gives the extent.  <a href="#afd1ecbed76a06e722f60fc2263f606e8"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a88960f501b0acae7645e396d28648210"></a><!-- doxytag: member="playerc_position1d_t::size" ref="a88960f501b0acae7645e396d28648210" args="[2]" -->
double&nbsp;</td><td class="memItemRight" valign="bottom"><b>size</b> [2]</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structplayerc__position1d__t.html#a299a7039abd250a579b3bf6ea29df76d">pos</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Odometric pose [m] or [rad].  <a href="#a299a7039abd250a579b3bf6ea29df76d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structplayerc__position1d__t.html#a1671c311f00852d8589f25fb51118bae">vel</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Odometric velocity [m/s] or [rad/s].  <a href="#a1671c311f00852d8589f25fb51118bae"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structplayerc__position1d__t.html#ae4b92ba1b009d60f897b9d10ee976e71">stall</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Stall flag [0, 1].  <a href="#ae4b92ba1b009d60f897b9d10ee976e71"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4b9ce32e8808a938091730363217d44e"></a><!-- doxytag: member="playerc_position1d_t::status" ref="a4b9ce32e8808a938091730363217d44e" args="" -->
int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structplayerc__position1d__t.html#a4b9ce32e8808a938091730363217d44e">status</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Status bitfield of extra data in the following order:</p>
<ul>
<li>status (unsigned byte)<ul>
<li>bit 0: limit min</li>
<li>bit 1: limit center</li>
<li>bit 2: limit max</li>
<li>bit 3: over current</li>
<li>bit 4: trajectory complete</li>
<li>bit 5: is enabled</li>
<li>bit 6:</li>
<li>bit 7: </li>
</ul>
</li>
</ul>
<br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Position1d device data. </p>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="af01a5d198961df625356028d537e1dfe"></a><!-- doxytag: member="playerc_position1d_t::info" ref="af01a5d198961df625356028d537e1dfe" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="struct__playerc__device__t.html">playerc_device_t</a> <a class="el" href="structplayerc__position1d__t.html#af01a5d198961df625356028d537e1dfe">playerc_position1d_t::info</a></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p><a class="el" href="classDevice.html" title="Encapsulates a device (i.e., a driver bound to an interface).">Device</a> info; must be at the start of all device structures. </p>

</div>
</div>
<a class="anchor" id="a299a7039abd250a579b3bf6ea29df76d"></a><!-- doxytag: member="playerc_position1d_t::pos" ref="a299a7039abd250a579b3bf6ea29df76d" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">double <a class="el" href="structplayerc__position1d__t.html#a299a7039abd250a579b3bf6ea29df76d">playerc_position1d_t::pos</a></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Odometric pose [m] or [rad]. </p>

</div>
</div>
<a class="anchor" id="afd1ecbed76a06e722f60fc2263f606e8"></a><!-- doxytag: member="playerc_position1d_t::pose" ref="afd1ecbed76a06e722f60fc2263f606e8" args="[3]" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">double <a class="el" href="structplayerc__position1d__t.html#afd1ecbed76a06e722f60fc2263f606e8">playerc_position1d_t::pose</a>[3]</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Robot geometry in robot cs: pose gives the position1d and orientation, size gives the extent. </p>
<p>These values are filled in by <a class="el" href="group__playerc__proxy__position1d.html#ga9d329fd512ccb16f50f130968e59cd1c" title="Get the position1d geometry.">playerc_position1d_get_geom()</a>. </p>

</div>
</div>
<a class="anchor" id="ae4b92ba1b009d60f897b9d10ee976e71"></a><!-- doxytag: member="playerc_position1d_t::stall" ref="ae4b92ba1b009d60f897b9d10ee976e71" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int <a class="el" href="structplayerc__position1d__t.html#ae4b92ba1b009d60f897b9d10ee976e71">playerc_position1d_t::stall</a></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Stall flag [0, 1]. </p>

</div>
</div>
<a class="anchor" id="a1671c311f00852d8589f25fb51118bae"></a><!-- doxytag: member="playerc_position1d_t::vel" ref="a1671c311f00852d8589f25fb51118bae" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">double <a class="el" href="structplayerc__position1d__t.html#a1671c311f00852d8589f25fb51118bae">playerc_position1d_t::vel</a></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Odometric velocity [m/s] or [rad/s]. </p>

</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="playerc_8h_source.html">playerc.h</a></li>
</ul>
</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>