<!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 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 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> | <a href="#pri-methods">Private Member Functions</a> | <a href="#pri-attribs">Private Attributes</a> </div> <div class="headertitle"> <h1>StatGrabDriver Class Reference</h1> </div> </div> <div class="contents"> <!-- doxytag: class="StatGrabDriver" --><!-- doxytag: inherits="ThreadedDriver" --><div class="dynheader"> Inheritance diagram for StatGrabDriver:</div> <div class="dyncontent"> <div class="center"> <img src="classStatGrabDriver.png" usemap="#StatGrabDriver_map" alt=""/> <map id="StatGrabDriver_map" name="StatGrabDriver_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="classStatGrabDriver-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="a8078c4258fdd6c69693c20bcec400dd2"></a><!-- doxytag: member="StatGrabDriver::StatGrabDriver" ref="a8078c4258fdd6c69693c20bcec400dd2" args="(ConfigFile *cf, int section)" --> </td><td class="memItemRight" valign="bottom"><b>StatGrabDriver</b> (<a class="el" href="classConfigFile.html">ConfigFile</a> *cf, int section)</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 </td><td class="memItemRight" valign="bottom"><a class="el" href="classStatGrabDriver.html#a741887f2b714853541ddd2b29dddbb56">Main</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Main method for driver thread. <a href="#a741887f2b714853541ddd2b29dddbb56"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab74f1876bd1c55242c24594e35b44607"></a><!-- doxytag: member="StatGrabDriver::MainSetup" ref="ab74f1876bd1c55242c24594e35b44607" args="()" --> int </td><td class="memItemRight" valign="bottom"><a class="el" href="classStatGrabDriver.html#ab74f1876bd1c55242c24594e35b44607">MainSetup</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Sets up the resources needed by the driver thread. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad7f2f7dbc3aa530078576bf7c40b09f3"></a><!-- doxytag: member="StatGrabDriver::RefreshData" ref="ad7f2f7dbc3aa530078576bf7c40b09f3" args="()" --> void </td><td class="memItemRight" valign="bottom"><b>RefreshData</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="ae2bc2f6c80a0e7a86abfca0af216f5ed"></a><!-- doxytag: member="StatGrabDriver::swap_stats" ref="ae2bc2f6c80a0e7a86abfca0af216f5ed" args="" --> sg_swap_stats * </td><td class="memItemRight" valign="bottom"><b>swap_stats</b></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1b2b85e21cda0d4a2e117278491c28e3"></a><!-- doxytag: member="StatGrabDriver::cpu_percent" ref="a1b2b85e21cda0d4a2e117278491c28e3" args="" --> sg_cpu_percents * </td><td class="memItemRight" valign="bottom"><b>cpu_percent</b></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a454d29d5795838aaf564d622b7730f01"></a><!-- doxytag: member="StatGrabDriver::mem_data" ref="a454d29d5795838aaf564d622b7730f01" args="" --> sg_mem_stats * </td><td class="memItemRight" valign="bottom"><b>mem_data</b></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab25474cd78cedaf62fe38ed16b1bf3cb"></a><!-- doxytag: member="StatGrabDriver::mem_percent" ref="ab25474cd78cedaf62fe38ed16b1bf3cb" args="" --> double </td><td class="memItemRight" valign="bottom"><b>mem_percent</b></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4efef1fa06005f097f153340f4032290"></a><!-- doxytag: member="StatGrabDriver::mHealthId" ref="a4efef1fa06005f097f153340f4032290" args="" --> <a class="el" href="structplayer__devaddr.html">player_devaddr_t</a> </td><td class="memItemRight" valign="bottom"><b>mHealthId</b></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7584a2536fe1b92dd47e200cde334d57"></a><!-- doxytag: member="StatGrabDriver::mHealth" ref="a7584a2536fe1b92dd47e200cde334d57" args="" --> <a class="el" href="structplayer__health__data.html">player_health_data_t</a> </td><td class="memItemRight" valign="bottom"><b>mHealth</b></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4eac5b21fd413f5e6629bcaa6bf2b010"></a><!-- doxytag: member="StatGrabDriver::status" ref="a4eac5b21fd413f5e6629bcaa6bf2b010" args="" --> int </td><td class="memItemRight" valign="bottom"><b>status</b></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a35a5fbbe34e783fbd76598a095d28203"></a><!-- doxytag: member="StatGrabDriver::mSleep" ref="a35a5fbbe34e783fbd76598a095d28203" args="" --> int32_t </td><td class="memItemRight" valign="bottom"><b>mSleep</b></td></tr> </table> <hr/><h2>Member Function Documentation</h2> <a class="anchor" id="a741887f2b714853541ddd2b29dddbb56"></a><!-- doxytag: member="StatGrabDriver::Main" ref="a741887f2b714853541ddd2b29dddbb56" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void StatGrabDriver::Main </td> <td>(</td> <td class="paramname"></td> <td> ) </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="classDriver.html#a91c6a959c611b5ff76623e82de665f68">Driver::ProcessMessages()</a>.</p> </div> </div> <hr/>The documentation for this class was generated from the following files:<ul> <li><a class="el" href="statgrab__health_8h_source.html">statgrab_health.h</a></li> <li>statgrab_health.cpp</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>