<!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="headertitle"> <h1>toranger.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 & Kasper Stoy</span> <a name="l00004"></a>00004 <span class="comment"> * gerkey@usc.edu kaspers@robotics.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="l00021"></a>00021 <a name="l00023"></a>00023 <span class="comment">//</span> <a name="l00024"></a>00024 <span class="comment">// Desc: Base class for ->ranger interface converter drivers.</span> <a name="l00025"></a>00025 <span class="comment">// Author: Geoffrey Biggs</span> <a name="l00026"></a>00026 <span class="comment">// Date: 06/05/2007</span> <a name="l00027"></a>00027 <span class="comment">//</span> <a name="l00029"></a>00029 <span class="comment"></span> <a name="l00030"></a>00030 <span class="preprocessor">#include <libplayercore/playercore.h></span> <a name="l00031"></a>00031 <a name="l00032"></a><a class="code" href="classToRanger.html">00032</a> <span class="keyword">class </span><a class="code" href="classToRanger.html">ToRanger</a> : <span class="keyword">public</span> <a class="code" href="classDriver.html" title="Base class for all drivers.">Driver</a> <a name="l00033"></a>00033 { <a name="l00034"></a>00034 <span class="keyword">public</span>: <a name="l00035"></a>00035 <a class="code" href="classToRanger.html">ToRanger</a> (<a class="code" href="classConfigFile.html" title="Class for loading configuration file information.">ConfigFile</a>* cf, <span class="keywordtype">int</span> section); <a name="l00036"></a>00036 ~<a class="code" href="classToRanger.html">ToRanger</a> (<span class="keywordtype">void</span>); <a name="l00037"></a>00037 <a name="l00038"></a>00038 <span class="comment">// Message processor - must be called first by child classes if overridden</span> <a name="l00039"></a>00039 <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classToRanger.html#a2a0a688951f0f51460c259584493e7ea" title="Message handler.">ProcessMessage</a> (<a class="code" href="classQueuePointer.html" title="An autopointer for the message queue.">QueuePointer</a> &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="l00040"></a>00040 <a name="l00041"></a>00041 <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classToRanger.html#af2ab9db1f9c039b0565109eb9a3058ca" title="Initialize the driver.">Setup</a> (<span class="keywordtype">void</span>); <a name="l00042"></a>00042 <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classToRanger.html#a66f110ef2e487636e608c553150bddf3" title="Finalize the driver.">Shutdown</a> (<span class="keywordtype">void</span>); <a name="l00043"></a>00043 <a name="l00044"></a>00044 <span class="keyword">protected</span>: <a name="l00045"></a>00045 <span class="comment">// Ranger interface stuff - should be filled by ProcessMessage()</span> <a name="l00046"></a>00046 <a class="code" href="structplayer__ranger__geom.html" title="Data and Request/reply: Get geometry.">player_ranger_geom_t</a> deviceGeom; <span class="comment">// Geometry of the device</span> <a name="l00047"></a>00047 <a name="l00048"></a>00048 <span class="comment">// Input device</span> <a name="l00049"></a>00049 <a class="code" href="classDevice.html" title="Encapsulates a device (i.e., a driver bound to an interface).">Device</a> *inputDevice; <span class="comment">// Input device interface</span> <a name="l00050"></a>00050 <a class="code" href="structplayer__devaddr.html" title="A device address.">player_devaddr_t</a> inputDeviceAddr; <span class="comment">// Input device address</span> <a name="l00051"></a>00051 }; </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>