<!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="#pro-methods">Protected Member Functions</a> |
<a href="#pro-attribs">Protected Attributes</a> |
<a href="#pri-methods">Private Member Functions</a> </div>
<div class="headertitle">
<h1>ImageBase Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="ImageBase" --><!-- doxytag: inherits="ThreadedDriver" --><div class="dynheader">
Inheritance diagram for ImageBase:</div>
<div class="dyncontent">
<div class="center">
<img src="classImageBase.png" usemap="#ImageBase_map" alt=""/>
<map id="ImageBase_map" name="ImageBase_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="classImageBase-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="a7d34c227b3c805bd5c76d195aec7fc14"></a><!-- doxytag: member="ImageBase::ImageBase" ref="a7d34c227b3c805bd5c76d195aec7fc14" args="(ConfigFile *cf, int section, bool overwrite_cmds, size_t queue_maxlen, int interf)" -->
</td><td class="memItemRight" valign="bottom"><b>ImageBase</b> (<a class="el" href="classConfigFile.html">ConfigFile</a> *cf, int section, bool overwrite_cmds, size_t queue_maxlen, int interf)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6a7a5c9a8b6bef2bbd17b54cc3bfae5f"></a><!-- doxytag: member="ImageBase::ImageBase" ref="a6a7a5c9a8b6bef2bbd17b54cc3bfae5f" args="(ConfigFile *cf, int section, bool overwrite_cmds=true, size_t queue_maxlen=PLAYER_MSGQUEUE_DEFAULT_MAXLEN)" -->
</td><td class="memItemRight" valign="bottom"><b>ImageBase</b> (<a class="el" href="classConfigFile.html">ConfigFile</a> *cf, int section, bool overwrite_cmds=true, size_t queue_maxlen=PLAYER_MSGQUEUE_DEFAULT_MAXLEN)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classImageBase.html#ae5a2a84cbe890dd5b257b2c7bb43d250">ProcessMessage</a> (<a class="el" href="classQueuePointer.html">QueuePointer</a> &resp_queue, <a class="el" href="structplayer__msghdr.html">player_msghdr</a> *hdr, void *data)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classMessage.html" title="Reference-counted message objects.">Message</a> handler. <a href="#ae5a2a84cbe890dd5b257b2c7bb43d250"></a><br/></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="a374e5effb48d45f9f91ca099e7b6c69b"></a><!-- doxytag: member="ImageBase::ProcessFrame" ref="a374e5effb48d45f9f91ca099e7b6c69b" args="()=0" -->
virtual int </td><td class="memItemRight" valign="bottom"><b>ProcessFrame</b> ()=0</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classImageBase.html#af65bd0ce994de91ccd6ba6cc7a18f6a9">Main</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Main method for driver thread. <a href="#af65bd0ce994de91ccd6ba6cc7a18f6a9"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af23227a29cf828ae353915e888be3cd4"></a><!-- doxytag: member="ImageBase::MainSetup" ref="af23227a29cf828ae353915e888be3cd4" args="()" -->
virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classImageBase.html#af23227a29cf828ae353915e888be3cd4">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">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classImageBase.html#afcc6276236e652af29f2c590e1a05de5">MainQuit</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Cleanup method for driver thread (called when main exits). <a href="#afcc6276236e652af29f2c590e1a05de5"></a><br/></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="aea0c5603fb5191370320f0c01d7b20bb"></a><!-- doxytag: member="ImageBase::camera_driver" ref="aea0c5603fb5191370320f0c01d7b20bb" args="" -->
<a class="el" href="classDevice.html">Device</a> * </td><td class="memItemRight" valign="bottom"><b>camera_driver</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3f851cf7b1b00e82f867fa632ad5935c"></a><!-- doxytag: member="ImageBase::camera_addr" ref="a3f851cf7b1b00e82f867fa632ad5935c" args="" -->
<a class="el" href="structplayer__devaddr.html">player_devaddr_t</a> </td><td class="memItemRight" valign="bottom"><b>camera_addr</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8b86e18e97de944bf68dc9b98d946206"></a><!-- doxytag: member="ImageBase::stored_data" ref="a8b86e18e97de944bf68dc9b98d946206" args="" -->
<a class="el" href="structplayer__camera__data.html">player_camera_data_t</a> </td><td class="memItemRight" valign="bottom"><b>stored_data</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aef69c5e5bd10e75d8d8e5f92e413be1b"></a><!-- doxytag: member="ImageBase::HaveData" ref="aef69c5e5bd10e75d8d8e5f92e413be1b" args="" -->
bool </td><td class="memItemRight" valign="bottom"><b>HaveData</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="a374c6dc645d7b0091f906e35a52d6165"></a><!-- doxytag: member="ImageBase::ImageBase" ref="a374c6dc645d7b0091f906e35a52d6165" args="(const ImageBase &)" -->
</td><td class="memItemRight" valign="bottom"><b>ImageBase</b> (const <a class="el" href="classImageBase.html">ImageBase</a> &)</td></tr>
</table>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="af65bd0ce994de91ccd6ba6cc7a18f6a9"></a><!-- doxytag: member="ImageBase::Main" ref="af65bd0ce994de91ccd6ba6cc7a18f6a9" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ImageBase::Main </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [protected, 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#a125eab00b72ad55885162aef7024e09b">Driver::InQueue</a>, and <a class="el" href="classDriver.html#a91c6a959c611b5ff76623e82de665f68">Driver::ProcessMessages()</a>.</p>
</div>
</div>
<a class="anchor" id="afcc6276236e652af29f2c590e1a05de5"></a><!-- doxytag: member="ImageBase::MainQuit" ref="afcc6276236e652af29f2c590e1a05de5" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ImageBase::MainQuit </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [protected, 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>
<p>References <a class="el" href="classDriver.html#a125eab00b72ad55885162aef7024e09b">Driver::InQueue</a>, and <a class="el" href="classDevice.html#a9f1e6c11baba44692a2e1f502d284201">Device::Unsubscribe()</a>.</p>
</div>
</div>
<a class="anchor" id="ae5a2a84cbe890dd5b257b2c7bb43d250"></a><!-- doxytag: member="ImageBase::ProcessMessage" ref="ae5a2a84cbe890dd5b257b2c7bb43d250" args="(QueuePointer &resp_queue, player_msghdr *hdr, void *data)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int ImageBase::ProcessMessage </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classQueuePointer.html">QueuePointer</a> & </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> * </td>
<td class="paramname"> <em>hdr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"> <em>data</em></td><td> </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> </td><td>The queue to which any response should go. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>hdr</em> </td><td>The message header </td></tr>
<tr><td valign="top"></td><td valign="top"><em>data</em> </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__camera__data.html#a3457008a7dc52a4fb45e440a40ccf8e5">player_camera_data::bpp</a>, <a class="el" href="structplayer__camera__data.html#aa5c4ff0aedc44d073477291ed4c4c1c6">player_camera_data::compression</a>, <a class="el" href="structplayer__camera__data.html#aeba7ebb2bfc7940b505d88cfd61d52ef">player_camera_data::fdiv</a>, <a class="el" href="structplayer__camera__data.html#a9deba275693548883f8e75284148d375">player_camera_data::format</a>, <a class="el" href="structplayer__camera__data.html#a6abed73d3ac124061c457e36d0a89893">player_camera_data::height</a>, <a class="el" href="structplayer__camera__data.html#a8b907a957de3ccbf7bbe27ad8e37de0d">player_camera_data::image</a>, <a class="el" href="structplayer__camera__data.html#afe85a18e4c72244a3dedbc1634ec1c31">player_camera_data::image_count</a>, <a class="el" href="classMessage.html#a5fd1734509a7520a64186c2653207751">Message::MatchMessage()</a>, <a class="el" href="group__interface__camera.html#ga53f904d017e4ee82f38136942465b39b">PLAYER_CAMERA_COMPRESS_JPEG</a>, <a class="el" href="group__interface__camera.html#gac695a7265d5a3ddbc8e9792bd711d5a3">PLAYER_CAMERA_DATA_STATE</a>, <a class="el" href="group__message__types.html#ga57872b03daef439c29a81f0aba7208b5">PLAYER_MSGTYPE_DATA</a>, and <a class="el" href="structplayer__camera__data.html#a51875beada5030d4dd159d5ae91c1dc9">player_camera_data::width</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="imagebase_8h_source.html">imagebase.h</a></li>
<li>imagebase.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>
distrib
>
Fedora
>
14
>
x86_64
>
media
>
updates
>
by-pkgid
>
727fa15453fcace956b835e2377d4269
>
files
>
147
