Sophie

Sophie

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

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-static-attribs">Static Public Attributes</a> &#124;
<a href="#pri-methods">Private Member Functions</a> &#124;
<a href="#pri-attribs">Private Attributes</a>  </div>
  <div class="headertitle">
<h1>RFLEX Class Reference</h1>  </div>
</div>
<div class="contents">
<!-- doxytag: class="RFLEX" --><!-- doxytag: inherits="ThreadedDriver" --><div class="dynheader">
Inheritance diagram for RFLEX:</div>
<div class="dyncontent">
 <div class="center">
  <img src="classRFLEX.png" usemap="#RFLEX_map" alt=""/>
  <map id="RFLEX_map" name="RFLEX_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"/>
</map>
</div>

<p><a href="classRFLEX-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="aac6427b862e6c979de07e09c4b9c3b81"></a><!-- doxytag: member="RFLEX::RFLEX" ref="aac6427b862e6c979de07e09c4b9c3b81" args="(ConfigFile *cf, int section)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><b>RFLEX</b> (<a class="el" href="classConfigFile.html">ConfigFile</a> *cf, int section)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRFLEX.html#a521224f2064ccf8a4c8b3529af3dc807">Main</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Main method for driver thread.  <a href="#a521224f2064ccf8a4c8b3529af3dc807"></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="classRFLEX.html#a7a5a79107a96615809121178a7cb1457">Subscribe</a> (<a class="el" href="structplayer__devaddr.html">player_devaddr_t</a> addr)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Subscribe to this driver.  <a href="#a7a5a79107a96615809121178a7cb1457"></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="classRFLEX.html#ab408a9d0713a56603480a4c52a7d41e9">Unsubscribe</a> (<a class="el" href="structplayer__devaddr.html">player_devaddr_t</a> addr)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Unsubscribe from this driver.  <a href="#ab408a9d0713a56603480a4c52a7d41e9"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRFLEX.html#affff879f42f059254b14430ec2b2bc83">MainQuit</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Cleanup method for driver thread (called when main exits).  <a href="#affff879f42f059254b14430ec2b2bc83"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRFLEX.html#ac7e6af9460ce66489b3cdb094950dbe0">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="#ac7e6af9460ce66489b3cdb094950dbe0"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pub-static-attribs"></a>
Static Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3ddcea813912b454928d0e41d8c52c95"></a><!-- doxytag: member="RFLEX::joy_control" ref="a3ddcea813912b454928d0e41d8c52c95" args="" -->
static int&nbsp;</td><td class="memItemRight" valign="bottom"><b>joy_control</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"><a class="anchor" id="a6da2a11db631d035cc8b0df051bd3af1"></a><!-- doxytag: member="RFLEX::ResetRawPositions" ref="a6da2a11db631d035cc8b0df051bd3af1" args="()" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><b>ResetRawPositions</b> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab97d82d5a28ecc3ee9c2da0b127a4ed2"></a><!-- doxytag: member="RFLEX::initialize_robot" ref="ab97d82d5a28ecc3ee9c2da0b127a4ed2" args="()" -->
int&nbsp;</td><td class="memItemRight" valign="bottom"><b>initialize_robot</b> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6e85634c7d72ef4c4e72b697eb2f7b33"></a><!-- doxytag: member="RFLEX::reset_odometry" ref="a6e85634c7d72ef4c4e72b697eb2f7b33" args="()" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><b>reset_odometry</b> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="adc779e348d6c7da31481c340ef50fa4b"></a><!-- doxytag: member="RFLEX::set_odometry" ref="adc779e348d6c7da31481c340ef50fa4b" args="(float, float, float)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><b>set_odometry</b> (float, float, float)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4039b21d3dd5eb74fabc265ed42b1e04"></a><!-- doxytag: member="RFLEX::update_everything" ref="a4039b21d3dd5eb74fabc265ed42b1e04" args="(player_rflex_data_t *d)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><b>update_everything</b> (player_rflex_data_t *d)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="adc9b05be56cf45f2d7cd1718f76c6104"></a><!-- doxytag: member="RFLEX::set_config_defaults" ref="adc9b05be56cf45f2d7cd1718f76c6104" args="()" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><b>set_config_defaults</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="a95265b0ca93b34a4bd1b1926178fbd71"></a><!-- doxytag: member="RFLEX::position_id" ref="a95265b0ca93b34a4bd1b1926178fbd71" args="" -->
<a class="el" href="structplayer__devaddr.html">player_devaddr_t</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>position_id</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7ad7fc006b493af7faba6411eb690a26"></a><!-- doxytag: member="RFLEX::sonar_id" ref="a7ad7fc006b493af7faba6411eb690a26" args="" -->
<a class="el" href="structplayer__devaddr.html">player_devaddr_t</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>sonar_id</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af0ec017b1eda9abbf9c8a6dab004f1ec"></a><!-- doxytag: member="RFLEX::sonar_id_2" ref="af0ec017b1eda9abbf9c8a6dab004f1ec" args="" -->
<a class="el" href="structplayer__devaddr.html">player_devaddr_t</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>sonar_id_2</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aae43ecbc9b8e8a00aedbc799f0e93211"></a><!-- doxytag: member="RFLEX::ir_id" ref="aae43ecbc9b8e8a00aedbc799f0e93211" args="" -->
<a class="el" href="structplayer__devaddr.html">player_devaddr_t</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>ir_id</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9aeb957fea9efa40be3c58eb43c43270"></a><!-- doxytag: member="RFLEX::bumper_id" ref="a9aeb957fea9efa40be3c58eb43c43270" args="" -->
<a class="el" href="structplayer__devaddr.html">player_devaddr_t</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>bumper_id</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a40541617bada5a2aed875a7cda4defde"></a><!-- doxytag: member="RFLEX::power_id" ref="a40541617bada5a2aed875a7cda4defde" args="" -->
<a class="el" href="structplayer__devaddr.html">player_devaddr_t</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>power_id</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a091fb48c246d8e028d88772f76189c98"></a><!-- doxytag: member="RFLEX::aio_id" ref="a091fb48c246d8e028d88772f76189c98" args="" -->
<a class="el" href="structplayer__devaddr.html">player_devaddr_t</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>aio_id</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9ea1bbaebf28bb699f0b67405b2bf023"></a><!-- doxytag: member="RFLEX::dio_id" ref="a9ea1bbaebf28bb699f0b67405b2bf023" args="" -->
<a class="el" href="structplayer__devaddr.html">player_devaddr_t</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>dio_id</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0ab2fadea37a8276b3f6f636a8d703a1"></a><!-- doxytag: member="RFLEX::command" ref="a0ab2fadea37a8276b3f6f636a8d703a1" args="" -->
<a class="el" href="structplayer__position2d__cmd__vel.html">player_position2d_cmd_vel_t</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>command</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae22414d58f5cea33724d99a36b9076bc"></a><!-- doxytag: member="RFLEX::command_type" ref="ae22414d58f5cea33724d99a36b9076bc" args="" -->
int&nbsp;</td><td class="memItemRight" valign="bottom"><b>command_type</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa72eb711d9200ea03387365c6eb79e17"></a><!-- doxytag: member="RFLEX::position_subscriptions" ref="aa72eb711d9200ea03387365c6eb79e17" args="" -->
int&nbsp;</td><td class="memItemRight" valign="bottom"><b>position_subscriptions</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa9d7ebbde2a220c615e4e2fdfa7e8a5e"></a><!-- doxytag: member="RFLEX::sonar_subscriptions" ref="aa9d7ebbde2a220c615e4e2fdfa7e8a5e" args="" -->
int&nbsp;</td><td class="memItemRight" valign="bottom"><b>sonar_subscriptions</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a704d767270592f82a783981652b2e908"></a><!-- doxytag: member="RFLEX::ir_subscriptions" ref="a704d767270592f82a783981652b2e908" args="" -->
int&nbsp;</td><td class="memItemRight" valign="bottom"><b>ir_subscriptions</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a40619abf7668f4c4b895526fde5382a6"></a><!-- doxytag: member="RFLEX::bumper_subscriptions" ref="a40619abf7668f4c4b895526fde5382a6" args="" -->
int&nbsp;</td><td class="memItemRight" valign="bottom"><b>bumper_subscriptions</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a188f883508da738f7a2928132d28e669"></a><!-- doxytag: member="RFLEX::rflex_fd" ref="a188f883508da738f7a2928132d28e669" args="" -->
int&nbsp;</td><td class="memItemRight" valign="bottom"><b>rflex_fd</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a649ecf4b24eaa3d313a35fa93e632d29"></a><!-- doxytag: member="RFLEX::rflex_serial_port" ref="a649ecf4b24eaa3d313a35fa93e632d29" args="[MAX_FILENAME_SIZE]" -->
char&nbsp;</td><td class="memItemRight" valign="bottom"><b>rflex_serial_port</b> [MAX_FILENAME_SIZE]</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="adf5c893cdcbf90a34c66a90fc60552d9"></a><!-- doxytag: member="RFLEX::m_odo_x" ref="adf5c893cdcbf90a34c66a90fc60552d9" args="" -->
double&nbsp;</td><td class="memItemRight" valign="bottom"><b>m_odo_x</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae0f71c834dc90ed56812969aa8b83a85"></a><!-- doxytag: member="RFLEX::m_odo_y" ref="ae0f71c834dc90ed56812969aa8b83a85" args="" -->
double&nbsp;</td><td class="memItemRight" valign="bottom"><b>m_odo_y</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac6eea52bb8d6c4631951250a41270c0a"></a><!-- doxytag: member="RFLEX::rad_odo_theta" ref="ac6eea52bb8d6c4631951250a41270c0a" args="" -->
double&nbsp;</td><td class="memItemRight" valign="bottom"><b>rad_odo_theta</b></td></tr>
</table>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a521224f2064ccf8a4c8b3529af3dc807"></a><!-- doxytag: member="RFLEX::Main" ref="a521224f2064ccf8a4c8b3529af3dc807" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void RFLEX::Main </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [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="structplayer__devaddr.html#ac6a1d9efc69d7dee301aba2ef4b5948d">player_devaddr::interf</a>, <a class="el" href="group__interface__aio.html#ga19e3b3e12364a28858c6ab86dede62d0">PLAYER_AIO_DATA_STATE</a>, <a class="el" href="group__interface__bumper.html#ga0862f34a5ef4d501df0c9a862797defa">PLAYER_BUMPER_DATA_STATE</a>, <a class="el" href="group__interface__dio.html#ga1cfec9baf479d3347041e67e03d70e75">PLAYER_DIO_DATA_VALUES</a>, <a class="el" href="group__libplayercommon.html#ga037512b044a9b748088953b8229daf7e">PLAYER_ERROR</a>, <a class="el" href="group__interface__ir.html#ga3d5529d4c3af65c084cd6aa7e5e36854">PLAYER_IR_DATA_RANGES</a>, <a class="el" href="group__libplayercommon.html#gad379e27a836c950a5d63905a61574d5d">PLAYER_MSG1</a>, <a class="el" href="group__message__types.html#ga57872b03daef439c29a81f0aba7208b5">PLAYER_MSGTYPE_DATA</a>, <a class="el" href="group__interface__position2d.html#gaf0fbfea4fcbea0c2eee0bedabd481fba">PLAYER_POSITION2D_DATA_STATE</a>, <a class="el" href="group__interface__power.html#ga720d4dddb48ab5d2ef81ddc9de3b283e">PLAYER_POWER_DATA_STATE</a>, <a class="el" href="group__interface__sonar.html#ga85129945cecde5b8562167ebdb84ee8c">PLAYER_SONAR_DATA_GEOM</a>, <a class="el" href="group__interface__sonar.html#gaf8eee80bf413a9cb2c443dbc81bd12d3">PLAYER_SONAR_DATA_RANGES</a>, <a class="el" href="structplayer__sonar__geom.html#a31c04415e8fc27eca23ac9ab05c4db7b">player_sonar_geom::poses</a>, <a class="el" href="structplayer__sonar__geom.html#a9901c9738d2383f8d493ee5d5fbc4f18">player_sonar_geom::poses_count</a>, <a class="el" href="classDriver.html#a91c6a959c611b5ff76623e82de665f68">Driver::ProcessMessages()</a>, <a class="el" href="classDriver.html#a8ac61526abb8989ca115bd773b7cbc1a">Driver::Publish()</a>, <a class="el" href="structplayer__pose3d.html#aa36562136aabc6805b4411d4b942e661">player_pose3d::px</a>, <a class="el" href="structplayer__pose3d.html#a7fc88aeb333507a6026af12116d933b6">player_pose3d::py</a>, <a class="el" href="structplayer__pose3d.html#abf168b9b5acd66c83a01783512be56dd">player_pose3d::pyaw</a>, and <a class="el" href="classThreadedDriver.html#a73fa72f806458014c9608d0945032f64">ThreadedDriver::Wait()</a>.</p>

</div>
</div>
<a class="anchor" id="affff879f42f059254b14430ec2b2bc83"></a><!-- doxytag: member="RFLEX::MainQuit" ref="affff879f42f059254b14430ec2b2bc83" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void RFLEX::MainQuit </td>
          <td>(</td>
          <td class="paramtype">void&nbsp;</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Cleanup method for driver thread (called when main exits). </p>
<p>Overload this method and to do additional cleanup when the driver thread exits. </p>

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

</div>
</div>
<a class="anchor" id="ac7e6af9460ce66489b3cdb094950dbe0"></a><!-- doxytag: member="RFLEX::ProcessMessage" ref="ac7e6af9460ce66489b3cdb094950dbe0" args="(QueuePointer &amp;resp_queue, player_msghdr *hdr, void *data)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int RFLEX::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__bumper__geom.html#a83ce3653c291e78289d0e9f3c6a97eb0">player_bumper_geom::bumper_def</a>, <a class="el" href="structplayer__bumper__geom.html#ac96216b1c0469d94d5fdef71876a3b14">player_bumper_geom::bumper_def_count</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__bumper.html#ga83ad4adc91c22190f5b4d46c3df43343">PLAYER_BUMPER_REQ_GET_GEOM</a>, <a class="el" href="group__interface__ir.html#gabd9f0ae263eb0b24cf0e7f74e45a3b7b">PLAYER_IR_REQ_POSE</a>, <a class="el" href="group__interface__ir.html#gab3685041fa1d49b6e1b5da711b568771">PLAYER_IR_REQ_POWER</a>, <a class="el" href="group__message__types.html#gaf8fb5087b5a1f4ec631034e71dec0f3d">PLAYER_MSGTYPE_CMD</a>, <a class="el" href="group__message__types.html#ga59ed953188471436df98bfc3adf0f457">PLAYER_MSGTYPE_REQ</a>, <a class="el" href="group__message__types.html#ga312e72e1417096125470061385979696">PLAYER_MSGTYPE_RESP_ACK</a>, <a class="el" href="group__interface__position2d.html#gacaf0b14c255b47d09fef5efd7dd0fb22">PLAYER_POSITION2D_CMD_VEL</a>, <a class="el" href="group__interface__position2d.html#ga66fec75cddfc8ff49ef5bca8de091c75">PLAYER_POSITION2D_REQ_GET_GEOM</a>, <a class="el" href="group__interface__position2d.html#ga72e5926ea39cef102c7c8c19a574eef6">PLAYER_POSITION2D_REQ_MOTOR_POWER</a>, <a class="el" href="group__interface__position2d.html#gaa413820e1c30ab43d3ccae15f2617bef">PLAYER_POSITION2D_REQ_RESET_ODOM</a>, <a class="el" href="group__interface__position2d.html#ga66d9cc2103dc207554a6466e685fc1fc">PLAYER_POSITION2D_REQ_SET_ODOM</a>, <a class="el" href="group__interface__position2d.html#gae49f0820a7309278ebe437235513e400">PLAYER_POSITION2D_REQ_VELOCITY_MODE</a>, <a class="el" href="group__interface__sonar.html#ga45656a48917e10274088612b0abb9c92">PLAYER_SONAR_REQ_GET_GEOM</a>, <a class="el" href="group__interface__sonar.html#ga6d1516d01ff7c8c3b1e15b037f744a09">PLAYER_SONAR_REQ_POWER</a>, <a class="el" href="structplayer__position2d__set__odom__req.html#a7ae5e74b34ca2c0643207c6570ff54b2">player_position2d_set_odom_req::pose</a>, <a class="el" href="structplayer__sonar__geom.html#a31c04415e8fc27eca23ac9ab05c4db7b">player_sonar_geom::poses</a>, <a class="el" href="structplayer__sonar__geom.html#a9901c9738d2383f8d493ee5d5fbc4f18">player_sonar_geom::poses_count</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="structplayer__position2d__geom.html#ad5867aec329d6b1370894fe3392a29a4">player_position2d_geom::size</a>, <a class="el" href="structplayer__bbox3d.html#ae5e642ddc5357ede0e2b7ca896e2b50d">player_bbox3d::sl</a>, <a class="el" href="structplayer__ir__power__req.html#afa72b7efe8ce124dcb53ade147f66816">player_ir_power_req::state</a>, <a class="el" href="structplayer__msghdr.html#aeba88246e5ba9d3d6c1f2b60c329352b">player_msghdr::subtype</a>, and <a class="el" href="structplayer__bbox3d.html#a44e93586d87a7cc4e2311ddc4d35e82b">player_bbox3d::sw</a>.</p>

</div>
</div>
<a class="anchor" id="a7a5a79107a96615809121178a7cb1457"></a><!-- doxytag: member="RFLEX::Subscribe" ref="a7a5a79107a96615809121178a7cb1457" args="(player_devaddr_t addr)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int RFLEX::Subscribe </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structplayer__devaddr.html">player_devaddr_t</a>&nbsp;</td>
          <td class="paramname"> <em>addr</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Subscribe to this driver. </p>
<p>The <a class="el" href="classRFLEX.html#a7a5a79107a96615809121178a7cb1457" title="Subscribe to this driver.">Subscribe()</a> and <a class="el" href="classRFLEX.html#ab408a9d0713a56603480a4c52a7d41e9" title="Unsubscribe from this driver.">Unsubscribe()</a> methods are used to control subscriptions to the driver; a driver MAY override them, but usually won't.</p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>addr</em>&nbsp;</td><td>Address of the device to subscribe to (the driver may have more than one interface). </td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Returns 0 on success. </dd></dl>

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

<p>References <a class="el" href="classDriver.html#ad56aad9b98662be96c000f4e3baf0ee3">Driver::Subscribe()</a>.</p>

</div>
</div>
<a class="anchor" id="ab408a9d0713a56603480a4c52a7d41e9"></a><!-- doxytag: member="RFLEX::Unsubscribe" ref="ab408a9d0713a56603480a4c52a7d41e9" args="(player_devaddr_t addr)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int RFLEX::Unsubscribe </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structplayer__devaddr.html">player_devaddr_t</a>&nbsp;</td>
          <td class="paramname"> <em>addr</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Unsubscribe from this driver. </p>
<p>The <a class="el" href="classRFLEX.html#a7a5a79107a96615809121178a7cb1457" title="Subscribe to this driver.">Subscribe()</a> and <a class="el" href="classRFLEX.html#ab408a9d0713a56603480a4c52a7d41e9" title="Unsubscribe from this driver.">Unsubscribe()</a> methods are used to control subscriptions to the driver; a driver MAY override them, but usually won't.</p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>addr</em>&nbsp;</td><td>Address of the device to unsubscribe from (the driver may have more than one interface). </td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Returns 0 on success. </dd></dl>

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

<p>References <a class="el" href="classDriver.html#a0f9daeb9fbb8fd0097e3e388fef686be">Driver::Unsubscribe()</a>.</p>

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