Sophie

Sophie

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

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-methods">Public Member Functions</a> &#124;
<a href="#pri-methods">Private Member Functions</a> &#124;
<a href="#pri-static-methods">Static Private Member Functions</a> &#124;
<a href="#pri-attribs">Private Attributes</a>  </div>
  <div class="headertitle">
<h1>AMCLLaser Class Reference</h1>  </div>
</div>
<div class="contents">
<!-- doxytag: class="AMCLLaser" --><!-- doxytag: inherits="AMCLSensor" --><div class="dynheader">
Inheritance diagram for AMCLLaser:</div>
<div class="dyncontent">
 <div class="center">
  <img src="classAMCLLaser.png" usemap="#AMCLLaser_map" alt=""/>
  <map id="AMCLLaser_map" name="AMCLLaser_map">
<area href="classAMCLSensor.html" alt="AMCLSensor" shape="rect" coords="0,0,88,24"/>
</map>
</div>

<p><a href="classAMCLLaser-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="a46fbd6e9c209878a7d1faf1341d29bac"></a><!-- doxytag: member="AMCLLaser::AMCLLaser" ref="a46fbd6e9c209878a7d1faf1341d29bac" args="(AdaptiveMCL &amp;aAMCL, player_devaddr_t addr)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><b>AMCLLaser</b> (<a class="el" href="classAdaptiveMCL.html">AdaptiveMCL</a> &amp;aAMCL, <a class="el" href="structplayer__devaddr.html">player_devaddr_t</a> addr)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2a32ff455e5dc6c55fdaa38df983268a"></a><!-- doxytag: member="AMCLLaser::Load" ref="a2a32ff455e5dc6c55fdaa38df983268a" args="(ConfigFile *cf, int section)" -->
virtual int&nbsp;</td><td class="memItemRight" valign="bottom"><b>Load</b> (<a class="el" href="classConfigFile.html">ConfigFile</a> *cf, int section)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a39a2b22a9872783f79282651b3b61c4c"></a><!-- doxytag: member="AMCLLaser::Unload" ref="a39a2b22a9872783f79282651b3b61c4c" args="(void)" -->
virtual int&nbsp;</td><td class="memItemRight" valign="bottom"><b>Unload</b> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a54b59f474e3392d4074c35e5fd091312"></a><!-- doxytag: member="AMCLLaser::Setup" ref="a54b59f474e3392d4074c35e5fd091312" args="(void)" -->
virtual int&nbsp;</td><td class="memItemRight" valign="bottom"><b>Setup</b> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a214a8bb4a012f0134598fdc65ff0be8e"></a><!-- doxytag: member="AMCLLaser::Shutdown" ref="a214a8bb4a012f0134598fdc65ff0be8e" args="(void)" -->
virtual int&nbsp;</td><td class="memItemRight" valign="bottom"><b>Shutdown</b> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a163ccfd30841b67a39fe371436cea23e"></a><!-- doxytag: member="AMCLLaser::ProcessMessage" ref="a163ccfd30841b67a39fe371436cea23e" args="(QueuePointer &amp;resp_queue, player_msghdr *hdr, void *data)" -->
virtual int&nbsp;</td><td class="memItemRight" valign="bottom"><b>ProcessMessage</b> (<a class="el" href="classQueuePointer.html">QueuePointer</a> &amp;resp_queue, <a class="el" href="structplayer__msghdr.html">player_msghdr</a> *hdr, void *data)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a179090d0bcf37e2a3927010e5726ffe7"></a><!-- doxytag: member="AMCLLaser::UpdateSensor" ref="a179090d0bcf37e2a3927010e5726ffe7" args="(pf_t *pf, AMCLSensorData *data)" -->
virtual bool&nbsp;</td><td class="memItemRight" valign="bottom"><b>UpdateSensor</b> (<a class="el" href="struct__pf__t.html">pf_t</a> *pf, <a class="el" href="classAMCLSensorData.html">AMCLSensorData</a> *data)</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="a86d641d55d3a422aee3d9560c5297889"></a><!-- doxytag: member="AMCLLaser::SetupMap" ref="a86d641d55d3a422aee3d9560c5297889" args="(void)" -->
int&nbsp;</td><td class="memItemRight" valign="bottom"><b>SetupMap</b> (void)</td></tr>
<tr><td colspan="2"><h2><a name="pri-static-methods"></a>
Static Private Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afe28cb12eda510dd4d9626408f2f769a"></a><!-- doxytag: member="AMCLLaser::SensorModel" ref="afe28cb12eda510dd4d9626408f2f769a" args="(AMCLLaserData *data, pf_sample_set_t *set)" -->
static double&nbsp;</td><td class="memItemRight" valign="bottom"><b>SensorModel</b> (<a class="el" href="classAMCLLaserData.html">AMCLLaserData</a> *data, <a class="el" href="struct__pf__sample__set__t.html">pf_sample_set_t</a> *set)</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="ae624ed3d0f664d2f1d679e73435d2e85"></a><!-- doxytag: member="AMCLLaser::laser_addr" ref="ae624ed3d0f664d2f1d679e73435d2e85" args="" -->
<a class="el" href="structplayer__devaddr.html">player_devaddr_t</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>laser_addr</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0c6ba5692856c1b896ff7992184b16ee"></a><!-- doxytag: member="AMCLLaser::map_addr" ref="a0c6ba5692856c1b896ff7992184b16ee" args="" -->
<a class="el" href="structplayer__devaddr.html">player_devaddr_t</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>map_addr</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0ae63d455afb3aa4deeb779656d7b983"></a><!-- doxytag: member="AMCLLaser::laser_dev" ref="a0ae63d455afb3aa4deeb779656d7b983" args="" -->
<a class="el" href="classDevice.html">Device</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><b>laser_dev</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afe5922e62af93f49615bfd4faf0cf125"></a><!-- doxytag: member="AMCLLaser::time" ref="afe5922e62af93f49615bfd4faf0cf125" args="" -->
double&nbsp;</td><td class="memItemRight" valign="bottom"><b>time</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a16b81517500798e69a73ff7b5772940d"></a><!-- doxytag: member="AMCLLaser::map" ref="a16b81517500798e69a73ff7b5772940d" args="" -->
<a class="el" href="structmap__t.html">map_t</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><b>map</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a71bff51bf042b0bc467673e081b4cf70"></a><!-- doxytag: member="AMCLLaser::laser_pose" ref="a71bff51bf042b0bc467673e081b4cf70" args="" -->
<a class="el" href="structpf__vector__t.html">pf_vector_t</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>laser_pose</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4c251d58a84399731ae403860ddf25cc"></a><!-- doxytag: member="AMCLLaser::max_beams" ref="a4c251d58a84399731ae403860ddf25cc" args="" -->
int&nbsp;</td><td class="memItemRight" valign="bottom"><b>max_beams</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a19e5b8116bef0df2056e038c02b74f86"></a><!-- doxytag: member="AMCLLaser::range_var" ref="a19e5b8116bef0df2056e038c02b74f86" args="" -->
double&nbsp;</td><td class="memItemRight" valign="bottom"><b>range_var</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afd1836b6e786f570153595ad56db2485"></a><!-- doxytag: member="AMCLLaser::range_bad" ref="afd1836b6e786f570153595ad56db2485" args="" -->
double&nbsp;</td><td class="memItemRight" valign="bottom"><b>range_bad</b></td></tr>
</table>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="amcl__laser_8h_source.html">amcl_laser.h</a></li>
<li>amcl_laser.cc</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>