Sophie

Sophie

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

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="#pub-attribs">Public Attributes</a> &#124;
<a href="#pro-methods">Protected Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a> &#124;
<a href="#pri-methods">Private Member Functions</a> &#124;
<a href="#pri-attribs">Private Attributes</a>  </div>
  <div class="headertitle">
<h1>snd Class Reference</h1>  </div>
</div>
<div class="contents">
<!-- doxytag: class="snd" --><!-- doxytag: inherits="ThreadedDriver" --><div class="dynheader">
Inheritance diagram for snd:</div>
<div class="dyncontent">
 <div class="center">
  <img src="classsnd.png" usemap="#snd_map" alt=""/>
  <map id="snd_map" name="snd_map">
<area href="classThreadedDriver.html" alt="ThreadedDriver" shape="rect" coords="0,56,102,80"/>
<area href="classDriver.html" alt="Driver" shape="rect" coords="0,0,102,24"/>
<area href="classsnd__Proxy.html" alt="snd_Proxy" shape="rect" coords="0,168,102,192"/>
</map>
</div>

<p><a href="classsnd-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="a1821671c6bfd1e054b4bafcd266cf4a5"></a><!-- doxytag: member="snd::snd" ref="a1821671c6bfd1e054b4bafcd266cf4a5" args="(ConfigFile *cf, int section)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><b>snd</b> (<a class="el" href="classConfigFile.html">ConfigFile</a> *cf, int section)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsnd.html#a72a5e2138eb746897909123a6a969784">Setup</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Initialize the driver.  <a href="#a72a5e2138eb746897909123a6a969784"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsnd.html#a0c601e3520ca8e8ba5c13e6677c4cc5a">Shutdown</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Finalize the driver.  <a href="#a0c601e3520ca8e8ba5c13e6677c4cc5a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsnd.html#a92897857622d982630d9d93104fd3b42">ProcessMessage</a> (<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="mdescLeft">&nbsp;</td><td class="mdescRight"><a class="el" href="classMessage.html" title="Reference-counted message objects.">Message</a> handler.  <a href="#a92897857622d982630d9d93104fd3b42"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5b98f1145370e60de3ae326635c0e6d6"></a><!-- doxytag: member="snd::WaitForNextGoal" ref="a5b98f1145370e60de3ae326635c0e6d6" args="()" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><b>WaitForNextGoal</b> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad5920176825c0524fa99a6dae0b5f481"></a><!-- doxytag: member="snd::SignalNextGoal" ref="ad5920176825c0524fa99a6dae0b5f481" args="(double goalX, double goalY, double goalA)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><b>SignalNextGoal</b> (double goalX, double goalY, double goalA)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad714cbb44c87a2fd087a10be0f1c79a3"></a><!-- doxytag: member="snd::Read" ref="ad714cbb44c87a2fd087a10be0f1c79a3" args="()" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><b>Read</b> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5b8c7e0c1b24fd0edf5d0d4366105298"></a><!-- doxytag: member="snd::ReadIfWaiting" ref="a5b8c7e0c1b24fd0edf5d0d4366105298" args="()" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><b>ReadIfWaiting</b> ()</td></tr>
<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="anchor" id="af97030aebb89fe6458be27a6d63f2321"></a><!-- doxytag: member="snd::robot_radius" ref="af97030aebb89fe6458be27a6d63f2321" args="" -->
double&nbsp;</td><td class="memItemRight" valign="bottom"><b>robot_radius</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a70d80a65692dd9028f365b2b3d6b3de3"></a><!-- doxytag: member="snd::min_gap_width" ref="a70d80a65692dd9028f365b2b3d6b3de3" args="" -->
double&nbsp;</td><td class="memItemRight" valign="bottom"><b>min_gap_width</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7c2e7a7693b76be6027052bc207e6477"></a><!-- doxytag: member="snd::obstacle_avoid_dist" ref="a7c2e7a7693b76be6027052bc207e6477" args="" -->
double&nbsp;</td><td class="memItemRight" valign="bottom"><b>obstacle_avoid_dist</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a06553616e5f892713ee17ac9716a2947"></a><!-- doxytag: member="snd::max_speed" ref="a06553616e5f892713ee17ac9716a2947" args="" -->
double&nbsp;</td><td class="memItemRight" valign="bottom"><b>max_speed</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7fabf8d318eb1b6d7bd695ab664f9439"></a><!-- doxytag: member="snd::max_turn_rate" ref="a7fabf8d318eb1b6d7bd695ab664f9439" args="" -->
double&nbsp;</td><td class="memItemRight" valign="bottom"><b>max_turn_rate</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a24aa2b7a58989758fe1abc2e521460d7"></a><!-- doxytag: member="snd::goal_position_tol" ref="a24aa2b7a58989758fe1abc2e521460d7" args="" -->
double&nbsp;</td><td class="memItemRight" valign="bottom"><b>goal_position_tol</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a02d4e5a5b83703027a46e6a9a1d3dc3d"></a><!-- doxytag: member="snd::goal_angle_tol" ref="a02d4e5a5b83703027a46e6a9a1d3dc3d" args="" -->
double&nbsp;</td><td class="memItemRight" valign="bottom"><b>goal_angle_tol</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0cc70debf4396a92bf4ce0a0b378a0e1"></a><!-- doxytag: member="snd::goalX" ref="a0cc70debf4396a92bf4ce0a0b378a0e1" args="" -->
double&nbsp;</td><td class="memItemRight" valign="bottom"><b>goalX</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a02d253e204c7446ad1d948768bd77631"></a><!-- doxytag: member="snd::goalY" ref="a02d253e204c7446ad1d948768bd77631" args="" -->
double&nbsp;</td><td class="memItemRight" valign="bottom"><b>goalY</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acaa55a436d21ad69f79d8f199b39975d"></a><!-- doxytag: member="snd::goalA" ref="acaa55a436d21ad69f79d8f199b39975d" args="" -->
double&nbsp;</td><td class="memItemRight" valign="bottom"><b>goalA</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac31bbc6e0e68b7a835863c01a96c5e26"></a><!-- doxytag: member="snd::algorithm_thread" ref="ac31bbc6e0e68b7a835863c01a96c5e26" args="" -->
pthread_t&nbsp;</td><td class="memItemRight" valign="bottom"><b>algorithm_thread</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4d53a8903747b7cc8996b2849113620c"></a><!-- doxytag: member="snd::goal_mutex" ref="a4d53a8903747b7cc8996b2849113620c" args="" -->
pthread_mutex_t&nbsp;</td><td class="memItemRight" valign="bottom"><b>goal_mutex</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a17b9b8f79537a187510883de2ba58722"></a><!-- doxytag: member="snd::goal_changed_cond" ref="a17b9b8f79537a187510883de2ba58722" args="" -->
pthread_cond_t&nbsp;</td><td class="memItemRight" valign="bottom"><b>goal_changed_cond</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a741096736a9703eb3c7b1415b42d4aba"></a><!-- doxytag: member="snd::goal_changed" ref="a741096736a9703eb3c7b1415b42d4aba" args="" -->
double&nbsp;</td><td class="memItemRight" valign="bottom"><b>goal_changed</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7d5b54dcf495762ea434b40ca840c27d"></a><!-- doxytag: member="snd::data_mutex" ref="a7d5b54dcf495762ea434b40ca840c27d" args="" -->
pthread_mutex_t&nbsp;</td><td class="memItemRight" valign="bottom"><b>data_mutex</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a24ec634a1af0c18c519c080fda1201c4"></a><!-- doxytag: member="snd::data_changed_cond" ref="a24ec634a1af0c18c519c080fda1201c4" args="" -->
pthread_cond_t&nbsp;</td><td class="memItemRight" valign="bottom"><b>data_changed_cond</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a51d5d92c200e0e721a12b756bcb46564"></a><!-- doxytag: member="snd::data_changed" ref="a51d5d92c200e0e721a12b756bcb46564" args="" -->
double&nbsp;</td><td class="memItemRight" valign="bottom"><b>data_changed</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a57de69b3b63c3e479b2b95561d0ad2d5"></a><!-- doxytag: member="snd::data_odometry_ready" ref="a57de69b3b63c3e479b2b95561d0ad2d5" args="" -->
int&nbsp;</td><td class="memItemRight" valign="bottom"><b>data_odometry_ready</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad6fff30eb92690a9ae1118de9f2a9f6f"></a><!-- doxytag: member="snd::data_laser_ready" ref="ad6fff30eb92690a9ae1118de9f2a9f6f" args="" -->
int&nbsp;</td><td class="memItemRight" valign="bottom"><b>data_laser_ready</b></td></tr>
<tr><td colspan="2"><h2><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab2c29eeecc64d10635a756cb7d1ab8d0"></a><!-- doxytag: member="snd::SetSpeedCmd" ref="ab2c29eeecc64d10635a756cb7d1ab8d0" args="(player_position2d_cmd_vel_t cmd)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><b>SetSpeedCmd</b> (<a class="el" href="structplayer__position2d__cmd__vel.html">player_position2d_cmd_vel_t</a> cmd)</td></tr>
<tr><td colspan="2"><h2><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae8eb3f1b5320e1b8233c31629f459c10"></a><!-- doxytag: member="snd::odom_pose" ref="ae8eb3f1b5320e1b8233c31629f459c10" args="" -->
<a class="el" href="structplayer__pose2d.html">player_pose2d_t</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>odom_pose</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0fe3692fce81f8d2000bd6df98ce6ecf"></a><!-- doxytag: member="snd::laser__ranges" ref="a0fe3692fce81f8d2000bd6df98ce6ecf" args="" -->
std::vector&lt; double &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><b>laser__ranges</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa7cb5fd9ebd8fc845e7cd5b42e68494a"></a><!-- doxytag: member="snd::laser__resolution" ref="aa7cb5fd9ebd8fc845e7cd5b42e68494a" args="" -->
double&nbsp;</td><td class="memItemRight" valign="bottom"><b>laser__resolution</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a78299f823c91804238291c9322882141"></a><!-- doxytag: member="snd::laser__max_range" ref="a78299f823c91804238291c9322882141" args="" -->
double&nbsp;</td><td class="memItemRight" valign="bottom"><b>laser__max_range</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae71b31931b8d327b1e57451d0d4a171f"></a><!-- doxytag: member="snd::laser__ranges_count" ref="ae71b31931b8d327b1e57451d0d4a171f" args="" -->
uint32_t&nbsp;</td><td class="memItemRight" valign="bottom"><b>laser__ranges_count</b></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">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsnd.html#aee309bd90b33851006be59b8782331d5">Main</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Main method for driver thread.  <a href="#aee309bd90b33851006be59b8782331d5"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2722ed459f2ff246cb1d42ceba7ce1f9"></a><!-- doxytag: member="snd::Odometry_Setup" ref="a2722ed459f2ff246cb1d42ceba7ce1f9" args="()" -->
int&nbsp;</td><td class="memItemRight" valign="bottom"><b>Odometry_Setup</b> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abae93b3d46ac2fb2eccedd009dc7a724"></a><!-- doxytag: member="snd::Laser_Setup" ref="abae93b3d46ac2fb2eccedd009dc7a724" args="()" -->
int&nbsp;</td><td class="memItemRight" valign="bottom"><b>Laser_Setup</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="abbe117d0a7e617bebf668f6d86b6e1d5"></a><!-- doxytag: member="snd::m_position_addr" ref="abbe117d0a7e617bebf668f6d86b6e1d5" args="" -->
<a class="el" href="structplayer__devaddr.html">player_devaddr_t</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>m_position_addr</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a634ca9ba77f97539bbeb6690911c26cb"></a><!-- doxytag: member="snd::m_laser_addr" ref="a634ca9ba77f97539bbeb6690911c26cb" args="" -->
<a class="el" href="structplayer__devaddr.html">player_devaddr_t</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>m_laser_addr</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a665f1302548b5340db39f139d347ea2c"></a><!-- doxytag: member="snd::laser_addr" ref="a665f1302548b5340db39f139d347ea2c" 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="a84497c2ebf4ca148d0d679fb4ddd89a8"></a><!-- doxytag: member="snd::odom_in_addr" ref="a84497c2ebf4ca148d0d679fb4ddd89a8" args="" -->
<a class="el" href="structplayer__devaddr.html">player_devaddr_t</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>odom_in_addr</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abc56d45511daa1a8ff4e199e5a32a56b"></a><!-- doxytag: member="snd::odom_out_addr" ref="abc56d45511daa1a8ff4e199e5a32a56b" args="" -->
<a class="el" href="structplayer__devaddr.html">player_devaddr_t</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>odom_out_addr</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a063db310b6db61fa266a2f3dc9409202"></a><!-- doxytag: member="snd::laser_dev" ref="a063db310b6db61fa266a2f3dc9409202" 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="ac170ee59e15e6a30a868b0009138cc2b"></a><!-- doxytag: member="snd::odom_in_dev" ref="ac170ee59e15e6a30a868b0009138cc2b" args="" -->
<a class="el" href="classDevice.html">Device</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><b>odom_in_dev</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="adf1b993db06cfd2de2257f8db9ed04ec"></a><!-- doxytag: member="snd::odom_out_dev" ref="adf1b993db06cfd2de2257f8db9ed04ec" args="" -->
<a class="el" href="classDevice.html">Device</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><b>odom_out_dev</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5724c8250f823d7ea3f849c8a946695d"></a><!-- doxytag: member="snd::robot_geom" ref="a5724c8250f823d7ea3f849c8a946695d" args="" -->
<a class="el" href="structplayer__position2d__geom.html">player_position2d_geom_t</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>robot_geom</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a612739b2898cf22ed78290b07e2650e2"></a><!-- doxytag: member="snd::first_goal_has_been_set_to_init_position" ref="a612739b2898cf22ed78290b07e2650e2" args="" -->
int&nbsp;</td><td class="memItemRight" valign="bottom"><b>first_goal_has_been_set_to_init_position</b></td></tr>
</table>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="aee309bd90b33851006be59b8782331d5"></a><!-- doxytag: member="snd::Main" ref="aee309bd90b33851006be59b8782331d5" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void snd::Main </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [private, virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Main method for driver thread. </p>
<p>drivers have their own thread of execution, created using StartThread(); this is the entry point for the driver thread, and must be overloaded by all threaded drivers. </p>

<p>Implements <a class="el" href="classThreadedDriver.html#a962ea9c4e4e36570dd33604552726ae9">ThreadedDriver</a>.</p>

<p>References <a class="el" href="group__libplayercommon.html#gae7553e0b3d58ba01b7ece74c89430cd7">PLAYER_MSG0</a>, <a class="el" href="classDriver.html#a91c6a959c611b5ff76623e82de665f68">Driver::ProcessMessages()</a>, and <a class="el" href="classThreadedDriver.html#a73fa72f806458014c9608d0945032f64">ThreadedDriver::Wait()</a>.</p>

</div>
</div>
<a class="anchor" id="a92897857622d982630d9d93104fd3b42"></a><!-- doxytag: member="snd::ProcessMessage" ref="a92897857622d982630d9d93104fd3b42" args="(QueuePointer &amp;resp_queue, player_msghdr *hdr, void *data)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int snd::ProcessMessage </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classQueuePointer.html">QueuePointer</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>resp_queue</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="structplayer__msghdr.html">player_msghdr</a> *&nbsp;</td>
          <td class="paramname"> <em>hdr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">void *&nbsp;</td>
          <td class="paramname"> <em>data</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p><a class="el" href="classMessage.html" title="Reference-counted message objects.">Message</a> handler. </p>
<p>This function is called once for each message in the incoming queue. Reimplement it to provide message handling. Return 0 if you handled the message and -1 otherwise</p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>resp_queue</em>&nbsp;</td><td>The queue to which any response should go. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>hdr</em>&nbsp;</td><td>The message header </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>data</em>&nbsp;</td><td>The message body </td></tr>
  </table>
  </dd>
</dl>

<p>Reimplemented from <a class="el" href="classDriver.html#ab05d0e8502a494a83d0442a48095a35c">Driver</a>.</p>

<p>References <a class="el" href="structplayer__msghdr.html#aefb4cbdabb4aa6cb01fd56ba7b2aeafb">player_msghdr::addr</a>, <a class="el" href="classDriver.html#a98fc106a6ad39263aa769b37bd58905c">Driver::device_addr</a>, <a class="el" href="classMessage.html#a657c46003857b54271a84c414eba5500">Message::GetHeader()</a>, <a class="el" href="classMessage.html#ae8f055a9308a86946a8a281599d3e2f0">Message::GetPayload()</a>, <a class="el" href="classMessage.html#a5fd1734509a7520a64186c2653207751">Message::MatchMessage()</a>, <a class="el" href="structplayer__pose2d.html#a81438ba2b285ecbd3e52ea39450b5a92">player_pose2d::pa</a>, <a class="el" href="group__interface__laser.html#ga99b20671325991998de43dcbbf213ea5">PLAYER_LASER_DATA_SCAN</a>, <a class="el" href="group__libplayercommon.html#gae7553e0b3d58ba01b7ece74c89430cd7">PLAYER_MSG0</a>, <a class="el" href="group__libplayercommon.html#ga8ed5d3c98dbd7e7f32fc980db221eadf">PLAYER_MSG3</a>, <a class="el" href="group__message__types.html#gaf8fb5087b5a1f4ec631034e71dec0f3d">PLAYER_MSGTYPE_CMD</a>, <a class="el" href="group__message__types.html#ga57872b03daef439c29a81f0aba7208b5">PLAYER_MSGTYPE_DATA</a>, <a class="el" href="group__message__types.html#ga59ed953188471436df98bfc3adf0f457">PLAYER_MSGTYPE_REQ</a>, <a class="el" href="group__interface__position2d.html#gaf0801065c6a46fda7e2734be3528911c">PLAYER_POSITION2D_CMD_POS</a>, <a class="el" href="group__interface__position2d.html#gacaf0b14c255b47d09fef5efd7dd0fb22">PLAYER_POSITION2D_CMD_VEL</a>, <a class="el" href="group__interface__position2d.html#gaf0fbfea4fcbea0c2eee0bedabd481fba">PLAYER_POSITION2D_DATA_STATE</a>, <a class="el" href="group__libplayercommon.html#ga65a614d6a5e549ca15019bcc8aa7f931">PLAYER_WARN1</a>, <a class="el" href="structplayer__position2d__cmd__pos.html#ae33de06007dd06614e273bc149bbc190">player_position2d_cmd_pos::pos</a>, <a class="el" href="classDriver.html#a8ac61526abb8989ca115bd773b7cbc1a">Driver::Publish()</a>, <a class="el" href="structplayer__pose2d.html#a7f84ac1c98924591797d8ce3de61d586">player_pose2d::px</a>, <a class="el" href="structplayer__pose2d.html#a9b31f8c715a04d1165f06a27f1ab6d18">player_pose2d::py</a>, <a class="el" href="classDevice.html#aeafd1418afc82da4603310b6e35ff3dc">Device::Request()</a>, <a class="el" href="structplayer__msghdr.html#a27ef3166ee2eacc5e694e5a20f6fe5b6">player_msghdr::size</a>, <a class="el" href="structplayer__msghdr.html#aeba88246e5ba9d3d6c1f2b60c329352b">player_msghdr::subtype</a>, <a class="el" href="structplayer__msghdr.html#af4034407074c43e83614c4e624c0db95">player_msghdr::timestamp</a>, and <a class="el" href="structplayer__msghdr.html#a1c20e2f82ad8f6164f7cf31d940255fb">player_msghdr::type</a>.</p>

</div>
</div>
<a class="anchor" id="a72a5e2138eb746897909123a6a969784"></a><!-- doxytag: member="snd::Setup" ref="a72a5e2138eb746897909123a6a969784" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int snd::Setup </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Initialize the driver. </p>
<p>This function is called with the first client subscribes; it MUST be implemented by the driver.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>Returns 0 on success. </dd></dl>

<p>Reimplemented from <a class="el" href="classThreadedDriver.html#a94bf4534088c9d13beaaa6dc1e968ca2">ThreadedDriver</a>.</p>

<p>References <a class="el" href="group__libplayercommon.html#gae7553e0b3d58ba01b7ece74c89430cd7">PLAYER_MSG0</a>.</p>

</div>
</div>
<a class="anchor" id="a0c601e3520ca8e8ba5c13e6677c4cc5a"></a><!-- doxytag: member="snd::Shutdown" ref="a0c601e3520ca8e8ba5c13e6677c4cc5a" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int snd::Shutdown </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Finalize the driver. </p>
<p>This function is called with the last client unsubscribes; the default version simple stops the driver thread if one is present. In this case resources should be cleaned up in MainQuit.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>Returns 0 on success. </dd></dl>

<p>Reimplemented from <a class="el" href="classThreadedDriver.html#a7e75af74ea086e8bfc96486fde229d4c">ThreadedDriver</a>.</p>

<p>References <a class="el" href="classDriver.html#a125eab00b72ad55885162aef7024e09b">Driver::InQueue</a>, <a class="el" href="group__libplayercommon.html#gae7553e0b3d58ba01b7ece74c89430cd7">PLAYER_MSG0</a>, <a class="el" href="classThreadedDriver.html#aa4da24d7ea63c4f720fa5e06f5e24e84">ThreadedDriver::StopThread()</a>, and <a class="el" href="classDevice.html#a9f1e6c11baba44692a2e1f502d284201">Device::Unsubscribe()</a>.</p>

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

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