Sophie

Sophie

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

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="headertitle">
<h1>imagebase.h</h1>  </div>
</div>
<div class="contents">
<div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span>
<a name="l00002"></a>00002 <span class="comment"> *  Player - One Hell of a Robot Server</span>
<a name="l00003"></a>00003 <span class="comment"> *  Copyright (C) 2000  Brian Gerkey et al</span>
<a name="l00004"></a>00004 <span class="comment"> *                      gerkey@usc.edu</span>
<a name="l00005"></a>00005 <span class="comment"> *</span>
<a name="l00006"></a>00006 <span class="comment"> *  This program is free software; you can redistribute it and/or modify</span>
<a name="l00007"></a>00007 <span class="comment"> *  it under the terms of the GNU General Public License as published by</span>
<a name="l00008"></a>00008 <span class="comment"> *  the Free Software Foundation; either version 2 of the License, or</span>
<a name="l00009"></a>00009 <span class="comment"> *  (at your option) any later version.</span>
<a name="l00010"></a>00010 <span class="comment"> *</span>
<a name="l00011"></a>00011 <span class="comment"> *  This program is distributed in the hope that it will be useful,</span>
<a name="l00012"></a>00012 <span class="comment"> *  but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00013"></a>00013 <span class="comment"> *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the</span>
<a name="l00014"></a>00014 <span class="comment"> *  GNU General Public License for more details.</span>
<a name="l00015"></a>00015 <span class="comment"> *</span>
<a name="l00016"></a>00016 <span class="comment"> *  You should have received a copy of the GNU General Public License</span>
<a name="l00017"></a>00017 <span class="comment"> *  along with this program; if not, write to the Free Software</span>
<a name="l00018"></a>00018 <span class="comment"> *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA</span>
<a name="l00019"></a>00019 <span class="comment"> *</span>
<a name="l00020"></a>00020 <span class="comment"> */</span>
<a name="l00022"></a>00022 <span class="comment">//</span>
<a name="l00023"></a>00023 <span class="comment">// Desc: base driver for image processing and transform drivers</span>
<a name="l00024"></a>00024 <span class="comment">// Author: Toby Collett</span>
<a name="l00025"></a>00025 <span class="comment">// Date: 15 Feb 2004</span>
<a name="l00026"></a>00026 <span class="comment">// CVS: $Id: imagebase.h 8003 2009-07-13 10:34:37Z thjc $</span>
<a name="l00027"></a>00027 <span class="comment">//</span>
<a name="l00029"></a>00029 <span class="comment"></span>
<a name="l00030"></a>00030 
<a name="l00058"></a>00058 <span class="preprocessor">#include &lt;libplayercore/playercore.h&gt;</span>
<a name="l00059"></a>00059 
<a name="l00060"></a>00060 <span class="comment">// Driver for detecting laser retro-reflectors.</span>
<a name="l00061"></a><a class="code" href="classImageBase.html">00061</a> <span class="keyword">class </span><a class="code" href="classImageBase.html">ImageBase</a> : <span class="keyword">public</span> <a class="code" href="classThreadedDriver.html" title="Base class for drivers which oeprate with a thread.">ThreadedDriver</a>
<a name="l00062"></a>00062 {
<a name="l00063"></a>00063         <span class="keyword">public</span>:
<a name="l00064"></a>00064                 <span class="comment">// Constructor</span>
<a name="l00065"></a>00065                 <a class="code" href="classImageBase.html">ImageBase</a>(<a class="code" href="classConfigFile.html" title="Class for loading configuration file information.">ConfigFile</a> *cf, <span class="keywordtype">int</span> section, <span class="keywordtype">bool</span> overwrite_cmds, <span class="keywordtype">size_t</span> queue_maxlen, <span class="keywordtype">int</span> interf);
<a name="l00066"></a>00066                 <a class="code" href="classImageBase.html">ImageBase</a>(<a class="code" href="classConfigFile.html" title="Class for loading configuration file information.">ConfigFile</a> *cf, <span class="keywordtype">int</span> section, <span class="keywordtype">bool</span> overwrite_cmds = <span class="keyword">true</span>, <span class="keywordtype">size_t</span> queue_maxlen = <a class="code" href="group__message__constants.html#gadc8ec6a059c812f77fc21dda2f70d1a6" title="Default maximum length for a message queue.">PLAYER_MSGQUEUE_DEFAULT_MAXLEN</a>);
<a name="l00067"></a>00067                 <span class="keyword">virtual</span> ~<a class="code" href="classImageBase.html">ImageBase</a>()
<a name="l00068"></a>00068                 {
<a name="l00069"></a>00069                   <span class="keywordflow">if</span> (stored_data.<a class="code" href="structplayer__camera__data.html#a8b907a957de3ccbf7bbe27ad8e37de0d" title="Compressed image data (byte-aligned, row major order).">image</a>) <span class="keyword">delete</span> [](stored_data.<a class="code" href="structplayer__camera__data.html#a8b907a957de3ccbf7bbe27ad8e37de0d" title="Compressed image data (byte-aligned, row major order).">image</a>);
<a name="l00070"></a>00070                   <a class="code" href="group__libplayercommon.html#ga107ea47b28d5a6293b328ece093a91db" title="Warning message macros.">PLAYER_WARN</a>(<span class="stringliteral">&quot;image deleted from the memory&quot;</span>);
<a name="l00071"></a>00071                 }
<a name="l00072"></a>00072 
<a name="l00073"></a>00073                 <span class="comment">// Process incoming messages from clients</span>
<a name="l00074"></a>00074                 <span class="keywordtype">int</span> <a class="code" href="classImageBase.html#ae5a2a84cbe890dd5b257b2c7bb43d250" title="Message handler.">ProcessMessage</a> (<a class="code" href="classQueuePointer.html" title="An autopointer for the message queue.">QueuePointer</a> &amp;resp_queue, <a class="code" href="structplayer__msghdr.html" title="Generic message header.">player_msghdr</a> * hdr, <span class="keywordtype">void</span> * data);
<a name="l00075"></a>00075 
<a name="l00076"></a>00076         <span class="keyword">private</span>:
<a name="l00077"></a>00077                 <a class="code" href="classImageBase.html">ImageBase</a>(); <span class="comment">// no default constructor</span>
<a name="l00078"></a>00078                 <a class="code" href="classImageBase.html">ImageBase</a>(<span class="keyword">const</span> <a class="code" href="classImageBase.html">ImageBase</a> &amp;); <span class="comment">// no copy constructor</span>
<a name="l00079"></a>00079 
<a name="l00080"></a>00080         <span class="keyword">protected</span>:
<a name="l00081"></a>00081                 <span class="keyword">virtual</span> <span class="keywordtype">int</span> ProcessFrame() = 0;
<a name="l00082"></a>00082                 <span class="comment">// Main functions for device thread.</span>
<a name="l00083"></a>00083                 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classImageBase.html#af65bd0ce994de91ccd6ba6cc7a18f6a9" title="Main method for driver thread.">Main</a>();
<a name="l00084"></a>00084                 <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classImageBase.html#af23227a29cf828ae353915e888be3cd4" title="Sets up the resources needed by the driver thread.">MainSetup</a>();
<a name="l00085"></a>00085                 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classImageBase.html#afcc6276236e652af29f2c590e1a05de5" title="Cleanup method for driver thread (called when main exits).">MainQuit</a>();
<a name="l00086"></a>00086 
<a name="l00087"></a>00087                 <span class="comment">// Input camera stuff</span>
<a name="l00088"></a>00088                 <a class="code" href="classDevice.html" title="Encapsulates a device (i.e., a driver bound to an interface).">Device</a> *camera_driver;
<a name="l00089"></a>00089                 <a class="code" href="structplayer__devaddr.html" title="A device address.">player_devaddr_t</a> camera_addr;
<a name="l00090"></a>00090                 <a class="code" href="structplayer__camera__data.html" title="Data: state (PLAYER_CAMERA_DATA_STATE).">player_camera_data_t</a> stored_data;
<a name="l00091"></a>00091                 <span class="keywordtype">bool</span> HaveData;
<a name="l00092"></a>00092 };
</pre></div></div>
</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>