Sophie

Sophie

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

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="navpath">
    <ul>
      <li><b>PlayerCc</b>      </li>
      <li><a class="el" href="classPlayerCc_1_1LocalizeProxy.html">PlayerCc::LocalizeProxy</a>      </li>
    </ul>
  </div>
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pri-methods">Private Member Functions</a> &#124;
<a href="#pri-attribs">Private Attributes</a>  </div>
  <div class="headertitle">
<h1>PlayerCc::LocalizeProxy Class Reference<br/>
<small>
[<a class="el" href="group__player__clientlib__cplusplus__proxies.html">Proxies</a>]</small>
</h1>  </div>
</div>
<div class="contents">
<!-- doxytag: class="PlayerCc::LocalizeProxy" --><!-- doxytag: inherits="PlayerCc::ClientProxy" -->
<p>The <code><a class="el" href="classPlayerCc_1_1LocalizeProxy.html" title="The LocalizeProxy class is used to control a localize device, which can provide multiple pose hypothe...">LocalizeProxy</a></code> class is used to control a <a class="el" href="group__interface__localize.html">localize</a> device, which can provide multiple pose hypotheses for a robot.  
<a href="#_details">More...</a></p>

<p><code>#include &lt;<a class="el" href="playerc_09_09_8h_source.html">playerc++.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for PlayerCc::LocalizeProxy:</div>
<div class="dyncontent">
 <div class="center">
  <img src="classPlayerCc_1_1LocalizeProxy.png" usemap="#PlayerCc::LocalizeProxy_map" alt=""/>
  <map id="PlayerCc::LocalizeProxy_map" name="PlayerCc::LocalizeProxy_map">
<area href="classPlayerCc_1_1ClientProxy.html" alt="PlayerCc::ClientProxy" shape="rect" coords="0,0,151,24"/>
</map>
</div>

<p><a href="classPlayerCc_1_1LocalizeProxy-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac687d13a64cbccd791cec463797b72ab"></a><!-- doxytag: member="PlayerCc::LocalizeProxy::LocalizeProxy" ref="ac687d13a64cbccd791cec463797b72ab" args="(PlayerClient *aPc, uint32_t aIndex=0)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPlayerCc_1_1LocalizeProxy.html#ac687d13a64cbccd791cec463797b72ab">LocalizeProxy</a> (<a class="el" href="classPlayerCc_1_1PlayerClient.html">PlayerClient</a> *aPc, uint32_t aIndex=0)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">constructor <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6baac56e16a478db80e9160b1a71f8f0"></a><!-- doxytag: member="PlayerCc::LocalizeProxy::~LocalizeProxy" ref="a6baac56e16a478db80e9160b1a71f8f0" args="()" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPlayerCc_1_1LocalizeProxy.html#a6baac56e16a478db80e9160b1a71f8f0">~LocalizeProxy</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">destructor <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a117951dba23c13988336c27bf445d22a"></a><!-- doxytag: member="PlayerCc::LocalizeProxy::GetMapSizeX" ref="a117951dba23c13988336c27bf445d22a" args="() const " -->
uint32_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPlayerCc_1_1LocalizeProxy.html#a117951dba23c13988336c27bf445d22a">GetMapSizeX</a> () const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight"><a class="el" href="classMap.html">Map</a> dimensions (cells). <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a85587d1d2c7f8202d574a046e1729db5"></a><!-- doxytag: member="PlayerCc::LocalizeProxy::GetMapSizeY" ref="a85587d1d2c7f8202d574a046e1729db5" args="() const " -->
uint32_t&nbsp;</td><td class="memItemRight" valign="bottom"><b>GetMapSizeY</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1a605f263905f9ddc9f8b842ea442520"></a><!-- doxytag: member="PlayerCc::LocalizeProxy::GetMapTileX" ref="a1a605f263905f9ddc9f8b842ea442520" args="() const " -->
uint32_t&nbsp;</td><td class="memItemRight" valign="bottom"><b>GetMapTileX</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a196d301863e6fb8896eb97490d069112"></a><!-- doxytag: member="PlayerCc::LocalizeProxy::GetMapTileY" ref="a196d301863e6fb8896eb97490d069112" args="() const " -->
uint32_t&nbsp;</td><td class="memItemRight" valign="bottom"><b>GetMapTileY</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a82c036aef32bd59625734f379d11348d"></a><!-- doxytag: member="PlayerCc::LocalizeProxy::GetMapScale" ref="a82c036aef32bd59625734f379d11348d" args="() const " -->
double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPlayerCc_1_1LocalizeProxy.html#a82c036aef32bd59625734f379d11348d">GetMapScale</a> () const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight"><a class="el" href="classMap.html">Map</a> scale (m/cell). <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a702f78896243d72a123accae9eb5c2bb"></a><!-- doxytag: member="PlayerCc::LocalizeProxy::GetPendingCount" ref="a702f78896243d72a123accae9eb5c2bb" args="() const " -->
uint32_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPlayerCc_1_1LocalizeProxy.html#a702f78896243d72a123accae9eb5c2bb">GetPendingCount</a> () const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Number of pending (unprocessed) sensor readings. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aba5b80706a3f321466838822f5ffbc6b"></a><!-- doxytag: member="PlayerCc::LocalizeProxy::GetHypothCount" ref="aba5b80706a3f321466838822f5ffbc6b" args="() const " -->
uint32_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPlayerCc_1_1LocalizeProxy.html#aba5b80706a3f321466838822f5ffbc6b">GetHypothCount</a> () const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Number of possible poses. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8c51420e3e1818e5268982da94cfbdbb"></a><!-- doxytag: member="PlayerCc::LocalizeProxy::GetHypoth" ref="a8c51420e3e1818e5268982da94cfbdbb" args="(uint32_t aIndex) const " -->
<a class="el" href="structplayer__localize__hypoth.html">player_localize_hypoth_t</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPlayerCc_1_1LocalizeProxy.html#a8c51420e3e1818e5268982da94cfbdbb">GetHypoth</a> (uint32_t aIndex) const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Array of possible poses. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1bcc1f2d85c0364368f58e56e5ec53ef"></a><!-- doxytag: member="PlayerCc::LocalizeProxy::GetParticles" ref="a1bcc1f2d85c0364368f58e56e5ec53ef" args="()" -->
int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPlayerCc_1_1LocalizeProxy.html#a1bcc1f2d85c0364368f58e56e5ec53ef">GetParticles</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the particle set. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a204311c9effc35d402698b360c9124c9"></a><!-- doxytag: member="PlayerCc::LocalizeProxy::GetParticlePose" ref="a204311c9effc35d402698b360c9124c9" args="(int index) const " -->
<a class="el" href="structplayer__pose2d.html">player_pose2d_t</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPlayerCc_1_1LocalizeProxy.html#a204311c9effc35d402698b360c9124c9">GetParticlePose</a> (int index) const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the Pose of a particle. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6998ad1a0e270a41b30fc0a665163cff"></a><!-- doxytag: member="PlayerCc::LocalizeProxy::SetPose" ref="a6998ad1a0e270a41b30fc0a665163cff" args="(double pose[3], double cov[3])" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPlayerCc_1_1LocalizeProxy.html#a6998ad1a0e270a41b30fc0a665163cff">SetPose</a> (double pose[3], double cov[3])</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the current pose hypothesis (m, m, radians). <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa42ec2fd2326a55ac37b976a4475a98c"></a><!-- doxytag: member="PlayerCc::LocalizeProxy::GetNumHypoths" ref="aa42ec2fd2326a55ac37b976a4475a98c" args="() const " -->
uint32_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPlayerCc_1_1LocalizeProxy.html#aa42ec2fd2326a55ac37b976a4475a98c">GetNumHypoths</a> () const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the number of localization hypoths. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">uint32_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPlayerCc_1_1LocalizeProxy.html#a96e91042c06ef8ec16a7968d3a2c801e">GetNumParticles</a> () const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the number of particles (for particle filter-based localization systems).  <a href="#a96e91042c06ef8ec16a7968d3a2c801e"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pri-methods"></a>
Private Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9dfb5cf1247fe925f0532d81da6c1325"></a><!-- doxytag: member="PlayerCc::LocalizeProxy::Subscribe" ref="a9dfb5cf1247fe925f0532d81da6c1325" args="(uint32_t aIndex)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><b>Subscribe</b> (uint32_t aIndex)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae3189904f4b6b6877d8b1ab2c4fc4f82"></a><!-- doxytag: member="PlayerCc::LocalizeProxy::Unsubscribe" ref="ae3189904f4b6b6877d8b1ab2c4fc4f82" args="()" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><b>Unsubscribe</b> ()</td></tr>
<tr><td colspan="2"><h2><a name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4f3edaff895ae3afe3a99e5f027218f5"></a><!-- doxytag: member="PlayerCc::LocalizeProxy::mDevice" ref="a4f3edaff895ae3afe3a99e5f027218f5" args="" -->
<a class="el" href="structplayerc__localize__t.html">playerc_localize_t</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><b>mDevice</b></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>The <code><a class="el" href="classPlayerCc_1_1LocalizeProxy.html" title="The LocalizeProxy class is used to control a localize device, which can provide multiple pose hypothe...">LocalizeProxy</a></code> class is used to control a <a class="el" href="group__interface__localize.html">localize</a> device, which can provide multiple pose hypotheses for a robot. </p>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a96e91042c06ef8ec16a7968d3a2c801e"></a><!-- doxytag: member="PlayerCc::LocalizeProxy::GetNumParticles" ref="a96e91042c06ef8ec16a7968d3a2c801e" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint32_t PlayerCc::LocalizeProxy::GetNumParticles </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Get the number of particles (for particle filter-based localization systems). </p>
<p>Returns the number of particles. </p>

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

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