Sophie

Sophie

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

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="#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>ClodBuster Class Reference</h1>  </div>
</div>
<div class="contents">
<!-- doxytag: class="ClodBuster" --><!-- doxytag: inherits="ThreadedDriver" --><div class="dynheader">
Inheritance diagram for ClodBuster:</div>
<div class="dyncontent">
 <div class="center">
  <img src="classClodBuster.png" usemap="#ClodBuster_map" alt=""/>
  <map id="ClodBuster_map" name="ClodBuster_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="classClodBuster-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="abc29c7016ceb67d5e85e034dee3d95b5"></a><!-- doxytag: member="ClodBuster::ClodBuster" ref="abc29c7016ceb67d5e85e034dee3d95b5" args="(ConfigFile *cf, int section)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><b>ClodBuster</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="classClodBuster.html#a17e7205d0e32302d52aa4dc1ef0d6c5e">Main</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Main method for driver thread.  <a href="#a17e7205d0e32302d52aa4dc1ef0d6c5e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classClodBuster.html#aae4c6405f68dba4402aea3d95e641c4f">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="#aae4c6405f68dba4402aea3d95e641c4f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a28abb1398c81d200906d358c207abcd0"></a><!-- doxytag: member="ClodBuster::MainSetup" ref="a28abb1398c81d200906d358c207abcd0" args="()" -->
virtual int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classClodBuster.html#a28abb1398c81d200906d358c207abcd0">MainSetup</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sets up the resources needed by the driver thread. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classClodBuster.html#ad46b7e3b71d424825a90cef4b8817b55">MainQuit</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Cleanup method for driver thread (called when main exits).  <a href="#ad46b7e3b71d424825a90cef4b8817b55"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3800b0470b3d95afa40362ce022d2154"></a><!-- doxytag: member="ClodBuster::SetServo" ref="a3800b0470b3d95afa40362ce022d2154" args="(unsigned char chan, int value)" -->
unsigned char&nbsp;</td><td class="memItemRight" valign="bottom"><b>SetServo</b> (unsigned char chan, int value)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4049e6b046c5462c22b9306291fb55a4"></a><!-- doxytag: member="ClodBuster::SetServo" ref="a4049e6b046c5462c22b9306291fb55a4" args="(unsigned char chan, unsigned char cmd)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><b>SetServo</b> (unsigned char chan, unsigned char 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="ac0d2faf3b61617e80458df0c54a3c038"></a><!-- doxytag: member="ClodBuster::motor_max_speed" ref="ac0d2faf3b61617e80458df0c54a3c038" args="" -->
int&nbsp;</td><td class="memItemRight" valign="bottom"><b>motor_max_speed</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a496d234bf19682ef62521ce90961feff"></a><!-- doxytag: member="ClodBuster::motor_max_turnspeed" ref="a496d234bf19682ef62521ce90961feff" args="" -->
int&nbsp;</td><td class="memItemRight" valign="bottom"><b>motor_max_turnspeed</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a27910917962c06b158c78d26a9a1e91c"></a><!-- doxytag: member="ClodBuster::use_vel_band" ref="a27910917962c06b158c78d26a9a1e91c" args="" -->
bool&nbsp;</td><td class="memItemRight" valign="bottom"><b>use_vel_band</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abf233e7b017d8503aacccc2b37753b9f"></a><!-- doxytag: member="ClodBuster::speedDemand" ref="abf233e7b017d8503aacccc2b37753b9f" args="" -->
short&nbsp;</td><td class="memItemRight" valign="bottom"><b>speedDemand</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3aad4bb41ed2bdae5ee82f837caae9a6"></a><!-- doxytag: member="ClodBuster::turnRateDemand" ref="a3aad4bb41ed2bdae5ee82f837caae9a6" args="" -->
short&nbsp;</td><td class="memItemRight" valign="bottom"><b>turnRateDemand</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a16e9f9842c9c36de5a8d144fac68f553"></a><!-- doxytag: member="ClodBuster::newmotorspeed" ref="a16e9f9842c9c36de5a8d144fac68f553" args="" -->
bool&nbsp;</td><td class="memItemRight" valign="bottom"><b>newmotorspeed</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa7e1616317033cd41a7a8046bcb6d4da"></a><!-- doxytag: member="ClodBuster::newmotorturn" ref="aa7e1616317033cd41a7a8046bcb6d4da" args="" -->
bool&nbsp;</td><td class="memItemRight" valign="bottom"><b>newmotorturn</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="acc3edf43a37d1b13768777e4c40a917c"></a><!-- doxytag: member="ClodBuster::ResetRawPositions" ref="acc3edf43a37d1b13768777e4c40a917c" 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="a42d51fbfb21bf96e4874be22f842bf57"></a><!-- doxytag: member="ClodBuster::ReadEncoders" ref="a42d51fbfb21bf96e4874be22f842bf57" args="()" -->
clodbuster_encoder_data_t&nbsp;</td><td class="memItemRight" valign="bottom"><b>ReadEncoders</b> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afc53bfded3f1421f8b9b2480a4776a50"></a><!-- doxytag: member="ClodBuster::GetGraspBoardParams" ref="afc53bfded3f1421f8b9b2480a4776a50" args="()" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><b>GetGraspBoardParams</b> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a519548577c2ce00356be02579f5c41f1"></a><!-- doxytag: member="ClodBuster::IntegrateEncoders" ref="a519548577c2ce00356be02579f5c41f1" args="()" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><b>IntegrateEncoders</b> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab850726031d7479364b9650bae26784d"></a><!-- doxytag: member="ClodBuster::DifferenceEncoders" ref="ab850726031d7479364b9650bae26784d" args="()" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><b>DifferenceEncoders</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="a2fe2e7803dc884132d6a2929775a6c90"></a><!-- doxytag: member="ClodBuster::position_data" ref="a2fe2e7803dc884132d6a2929775a6c90" args="" -->
<a class="el" href="structplayer__position2d__data.html">player_position2d_data_t</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>position_data</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4db7b88be68304da8bc18ef280872f8d"></a><!-- doxytag: member="ClodBuster::clodbuster_fd" ref="a4db7b88be68304da8bc18ef280872f8d" args="" -->
int&nbsp;</td><td class="memItemRight" valign="bottom"><b>clodbuster_fd</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae04f398d8a0936dda400ca5101c2f496"></a><!-- doxytag: member="ClodBuster::clodbuster_serial_port" ref="ae04f398d8a0936dda400ca5101c2f496" args="[MAX_FILENAME_SIZE]" -->
char&nbsp;</td><td class="memItemRight" valign="bottom"><b>clodbuster_serial_port</b> [MAX_FILENAME_SIZE]</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6180ba4180c60aa517cf6de86a059c73"></a><!-- doxytag: member="ClodBuster::kp" ref="a6180ba4180c60aa517cf6de86a059c73" args="" -->
int&nbsp;</td><td class="memItemRight" valign="bottom"><b>kp</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0502aa50bafcbf9bb8790d5643aaf8a8"></a><!-- doxytag: member="ClodBuster::ki" ref="a0502aa50bafcbf9bb8790d5643aaf8a8" args="" -->
int&nbsp;</td><td class="memItemRight" valign="bottom"><b>ki</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a490ebac663257cc3f2fbaedfa25e35a6"></a><!-- doxytag: member="ClodBuster::kd" ref="a490ebac663257cc3f2fbaedfa25e35a6" args="" -->
int&nbsp;</td><td class="memItemRight" valign="bottom"><b>kd</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a29276c4cecbe48df97c9f0ea323f91da"></a><!-- doxytag: member="ClodBuster::initdone" ref="a29276c4cecbe48df97c9f0ea323f91da" args="" -->
bool&nbsp;</td><td class="memItemRight" valign="bottom"><b>initdone</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8f43aa5becc24be4f62db4ff94a7a65b"></a><!-- doxytag: member="ClodBuster::encoder_offset" ref="a8f43aa5becc24be4f62db4ff94a7a65b" args="" -->
clodbuster_encoder_data_t&nbsp;</td><td class="memItemRight" valign="bottom"><b>encoder_offset</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acc442e9e50f3f28bc2910502b1afe691"></a><!-- doxytag: member="ClodBuster::encoder_measurement" ref="acc442e9e50f3f28bc2910502b1afe691" args="" -->
clodbuster_encoder_data_t&nbsp;</td><td class="memItemRight" valign="bottom"><b>encoder_measurement</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af86b4472b020103f0b6d5801c6682eff"></a><!-- doxytag: member="ClodBuster::old_encoder_measurement" ref="af86b4472b020103f0b6d5801c6682eff" args="" -->
clodbuster_encoder_data_t&nbsp;</td><td class="memItemRight" valign="bottom"><b>old_encoder_measurement</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a296ef0917099ed46c0988ed9471348ac"></a><!-- doxytag: member="ClodBuster::EncV" ref="a296ef0917099ed46c0988ed9471348ac" args="" -->
float&nbsp;</td><td class="memItemRight" valign="bottom"><b>EncV</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa8aaf41ecf80c00b3b8cf53c5d6d019a"></a><!-- doxytag: member="ClodBuster::EncOmega" ref="aa8aaf41ecf80c00b3b8cf53c5d6d019a" args="" -->
float&nbsp;</td><td class="memItemRight" valign="bottom"><b>EncOmega</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac1b85a5d5cbd402b79223012024f60bd"></a><!-- doxytag: member="ClodBuster::EncVleft" ref="ac1b85a5d5cbd402b79223012024f60bd" args="" -->
float&nbsp;</td><td class="memItemRight" valign="bottom"><b>EncVleft</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8fca0e031d8a13292fe601b84498bf58"></a><!-- doxytag: member="ClodBuster::EncVright" ref="a8fca0e031d8a13292fe601b84498bf58" args="" -->
float&nbsp;</td><td class="memItemRight" valign="bottom"><b>EncVright</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a14e6441e598e8e00f19280351b450d0d"></a><!-- doxytag: member="ClodBuster::direct_command_control" ref="a14e6441e598e8e00f19280351b450d0d" args="" -->
bool&nbsp;</td><td class="memItemRight" valign="bottom"><b>direct_command_control</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac05bd77c18869273b65d977cb0ba33ed"></a><!-- doxytag: member="ClodBuster::max_limits" ref="ac05bd77c18869273b65d977cb0ba33ed" args="[SERVO_CHANNELS]" -->
unsigned char&nbsp;</td><td class="memItemRight" valign="bottom"><b>max_limits</b> [SERVO_CHANNELS]</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afc14e67e226beb510b793efc3168f8cd"></a><!-- doxytag: member="ClodBuster::center_limits" ref="afc14e67e226beb510b793efc3168f8cd" args="[SERVO_CHANNELS]" -->
unsigned char&nbsp;</td><td class="memItemRight" valign="bottom"><b>center_limits</b> [SERVO_CHANNELS]</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9a628ac193fd9518b9b36bcb51005d91"></a><!-- doxytag: member="ClodBuster::min_limits" ref="a9a628ac193fd9518b9b36bcb51005d91" args="[SERVO_CHANNELS]" -->
unsigned char&nbsp;</td><td class="memItemRight" valign="bottom"><b>min_limits</b> [SERVO_CHANNELS]</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae763159986bc4c2cf8b8cf79b728a7da"></a><!-- doxytag: member="ClodBuster::WheelRadius" ref="ae763159986bc4c2cf8b8cf79b728a7da" args="" -->
float&nbsp;</td><td class="memItemRight" valign="bottom"><b>WheelRadius</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad39a8530c2f287029e82d4534557631c"></a><!-- doxytag: member="ClodBuster::WheelBase" ref="ad39a8530c2f287029e82d4534557631c" args="" -->
float&nbsp;</td><td class="memItemRight" valign="bottom"><b>WheelBase</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aaa92f2d210707996f81995e589d5b71e"></a><!-- doxytag: member="ClodBuster::WheelSeparation" ref="aaa92f2d210707996f81995e589d5b71e" args="" -->
float&nbsp;</td><td class="memItemRight" valign="bottom"><b>WheelSeparation</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afe8327a6e6b3d5e6c33aaf8f85a98d15"></a><!-- doxytag: member="ClodBuster::CountsPerRev" ref="afe8327a6e6b3d5e6c33aaf8f85a98d15" args="" -->
unsigned int&nbsp;</td><td class="memItemRight" valign="bottom"><b>CountsPerRev</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a589b4905733349bda5fa8308f902a375"></a><!-- doxytag: member="ClodBuster::Kenc" ref="a589b4905733349bda5fa8308f902a375" args="" -->
float&nbsp;</td><td class="memItemRight" valign="bottom"><b>Kenc</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a826b553ac41adbd4d4f7b3d88e8554fb"></a><!-- doxytag: member="ClodBuster::LoopFreq" ref="a826b553ac41adbd4d4f7b3d88e8554fb" args="" -->
float&nbsp;</td><td class="memItemRight" valign="bottom"><b>LoopFreq</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a79dd0d5ee4a818644d788b0e08aa68a5"></a><!-- doxytag: member="ClodBuster::Kv" ref="a79dd0d5ee4a818644d788b0e08aa68a5" args="" -->
<a class="el" href="classPIDGains.html">PIDGains</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><b>Kv</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1387038a2ba7072ccf9a6e0f534da3dc"></a><!-- doxytag: member="ClodBuster::Kw" ref="a1387038a2ba7072ccf9a6e0f534da3dc" args="" -->
<a class="el" href="classPIDGains.html">PIDGains</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><b>Kw</b></td></tr>
</table>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a17e7205d0e32302d52aa4dc1ef0d6c5e"></a><!-- doxytag: member="ClodBuster::Main" ref="a17e7205d0e32302d52aa4dc1ef0d6c5e" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void ClodBuster::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="classDriver.html#a98fc106a6ad39263aa769b37bd58905c">Driver::device_addr</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="classDriver.html#a91c6a959c611b5ff76623e82de665f68">Driver::ProcessMessages()</a>, and <a class="el" href="classDriver.html#a8ac61526abb8989ca115bd773b7cbc1a">Driver::Publish()</a>.</p>

</div>
</div>
<a class="anchor" id="ad46b7e3b71d424825a90cef4b8817b55"></a><!-- doxytag: member="ClodBuster::MainQuit" ref="ad46b7e3b71d424825a90cef4b8817b55" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void ClodBuster::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="aae4c6405f68dba4402aea3d95e641c4f"></a><!-- doxytag: member="ClodBuster::ProcessMessage" ref="aae4c6405f68dba4402aea3d95e641c4f" args="(QueuePointer &amp;resp_queue, player_msghdr *hdr, void *data)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int ClodBuster::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="classDriver.html#a98fc106a6ad39263aa769b37bd58905c">Driver::device_addr</a>, <a class="el" href="structplayer__position2d__speed__pid__req.html#ae0f60ea11e6005b6913d5da7206a40c5">player_position2d_speed_pid_req::kd</a>, <a class="el" href="structplayer__position2d__speed__pid__req.html#aac869f0c0142033eb7206be7cbd4b192">player_position2d_speed_pid_req::ki</a>, <a class="el" href="structplayer__position2d__speed__pid__req.html#ada4d44e1b2d4c290117aa3f074e7d78f">player_position2d_speed_pid_req::kp</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__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#gad5292f3dd4b1d067ec46f276694c5a4c">PLAYER_POSITION2D_REQ_SPEED_PID</a>, <a class="el" href="group__interface__position2d.html#gae49f0820a7309278ebe437235513e400">PLAYER_POSITION2D_REQ_VELOCITY_MODE</a>, <a class="el" href="structplayer__position2d__data.html#aec2b4f19406a26db96ef38f8b8b9c733">player_position2d_data::pos</a>, <a class="el" href="structplayer__position2d__geom.html#a610b44830e27c0626f2b2c4c5cecc558">player_position2d_geom::pose</a>, <a class="el" href="structplayer__position2d__set__odom__req.html#a7ae5e74b34ca2c0643207c6570ff54b2">player_position2d_set_odom_req::pose</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__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>, <a class="el" href="structplayer__position2d__geom.html#ad5867aec329d6b1370894fe3392a29a4">player_position2d_geom::size</a>, <a class="el" href="structplayer__msghdr.html#a27ef3166ee2eacc5e694e5a20f6fe5b6">player_msghdr::size</a>, <a class="el" href="structplayer__bbox3d.html#ae5e642ddc5357ede0e2b7ca896e2b50d">player_bbox3d::sl</a>, <a class="el" href="structplayer__position2d__power__config.html#a9a27cd9a1b0b89ea1e3a9846fc500add">player_position2d_power_config::state</a>, <a class="el" href="structplayer__bbox3d.html#a44e93586d87a7cc4e2311ddc4d35e82b">player_bbox3d::sw</a>, <a class="el" href="structplayer__position2d__velocity__mode__config.html#a1a8cc85d2d2cf31a682cbcf0a969366b">player_position2d_velocity_mode_config::value</a>, and <a class="el" href="structplayer__position2d__cmd__vel.html#a38db0013f72bf2787356ff2b47c5ee00">player_position2d_cmd_vel::vel</a>.</p>

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