<!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-attribs">Protected Attributes</a> </div> <div class="headertitle"> <h1>ToRanger Class Reference</h1> </div> </div> <div class="contents"> <!-- doxytag: class="ToRanger" --><!-- doxytag: inherits="Driver" --><div class="dynheader"> Inheritance diagram for ToRanger:</div> <div class="dyncontent"> <div class="center"> <img src="classToRanger.png" usemap="#ToRanger_map" alt=""/> <map id="ToRanger_map" name="ToRanger_map"> <area href="classDriver.html" alt="Driver" shape="rect" coords="0,0,67,24"/> </map> </div> <p><a href="classToRanger-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="a1037c0c61e7658a0ebe2d8846f596397"></a><!-- doxytag: member="ToRanger::ToRanger" ref="a1037c0c61e7658a0ebe2d8846f596397" args="(ConfigFile *cf, int section)" --> </td><td class="memItemRight" valign="bottom"><b>ToRanger</b> (<a class="el" href="classConfigFile.html">ConfigFile</a> *cf, int section)</td></tr> <tr><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classToRanger.html#a2a0a688951f0f51460c259584493e7ea">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="#a2a0a688951f0f51460c259584493e7ea"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classToRanger.html#af2ab9db1f9c039b0565109eb9a3058ca">Setup</a> (void)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Initialize the driver. <a href="#af2ab9db1f9c039b0565109eb9a3058ca"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classToRanger.html#a66f110ef2e487636e608c553150bddf3">Shutdown</a> (void)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Finalize the driver. <a href="#a66f110ef2e487636e608c553150bddf3"></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="aed6ab45f35d2a15367480d9ee6632131"></a><!-- doxytag: member="ToRanger::deviceGeom" ref="aed6ab45f35d2a15367480d9ee6632131" args="" --> <a class="el" href="structplayer__ranger__geom.html">player_ranger_geom_t</a> </td><td class="memItemRight" valign="bottom"><b>deviceGeom</b></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="adbcdf47204c977a04aba0cc9ebc26030"></a><!-- doxytag: member="ToRanger::inputDevice" ref="adbcdf47204c977a04aba0cc9ebc26030" args="" --> <a class="el" href="classDevice.html">Device</a> * </td><td class="memItemRight" valign="bottom"><b>inputDevice</b></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a26dc4ca17b2c0494adc7d3b14b8e4ba4"></a><!-- doxytag: member="ToRanger::inputDeviceAddr" ref="a26dc4ca17b2c0494adc7d3b14b8e4ba4" args="" --> <a class="el" href="structplayer__devaddr.html">player_devaddr_t</a> </td><td class="memItemRight" valign="bottom"><b>inputDeviceAddr</b></td></tr> </table> <hr/><h2>Member Function Documentation</h2> <a class="anchor" id="a2a0a688951f0f51460c259584493e7ea"></a><!-- doxytag: member="ToRanger::ProcessMessage" ref="a2a0a688951f0f51460c259584493e7ea" args="(QueuePointer &resp_queue, player_msghdr *hdr, void *data)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int ToRanger::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__msghdr.html#aefb4cbdabb4aa6cb01fd56ba7b2aeafb">player_msghdr::addr</a>, <a class="el" href="classDriver.html#a98fc106a6ad39263aa769b37bd58905c">Driver::device_addr</a>, <a class="el" href="classDriver.html#a125eab00b72ad55885162aef7024e09b">Driver::InQueue</a>, <a class="el" href="classMessage.html#a5fd1734509a7520a64186c2653207751">Message::MatchMessage()</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__message__types.html#gae80fbeee8ef3da0e6f78ec1a18613750">PLAYER_MSGTYPE_RESP_NACK</a>, <a class="el" href="classDriver.html#a8ac61526abb8989ca115bd773b7cbc1a">Driver::Publish()</a>, <a class="el" href="classDevice.html#a37323e0a016d0f8fb544199129f05a4e">Device::PutMsg()</a>, and <a class="el" href="classDriver.html#a75f76dccef5f9e45877df163c984d044">Driver::ret_queue</a>.</p> </div> </div> <a class="anchor" id="af2ab9db1f9c039b0565109eb9a3058ca"></a><!-- doxytag: member="ToRanger::Setup" ref="af2ab9db1f9c039b0565109eb9a3058ca" args="(void)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int ToRanger::Setup </td> <td>(</td> <td class="paramtype">void </td> <td class="paramname"></td> <td> ) </td> <td><code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Initialize the driver. </p> <p>This function is called with the first client subscribes; it MUST be implemented by the driver.</p> <dl class="return"><dt><b>Returns:</b></dt><dd>Returns 0 on success. </dd></dl> <p>Reimplemented from <a class="el" href="classDriver.html#a5873d50541d254ec1eb6f472ded097b0">Driver</a>.</p> <p>References <a class="el" href="structplayer__ranger__geom.html#a8f8fbdf86759d5a8e8b7bd2cee0b2124">player_ranger_geom::element_poses</a>, and <a class="el" href="structplayer__ranger__geom.html#a6c73870847ec75a190d04ae200042000">player_ranger_geom::element_sizes</a>.</p> </div> </div> <a class="anchor" id="a66f110ef2e487636e608c553150bddf3"></a><!-- doxytag: member="ToRanger::Shutdown" ref="a66f110ef2e487636e608c553150bddf3" args="(void)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int ToRanger::Shutdown </td> <td>(</td> <td class="paramtype">void </td> <td class="paramname"></td> <td> ) </td> <td><code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Finalize the driver. </p> <p>This function is called with the last client unsubscribes.</p> <dl class="return"><dt><b>Returns:</b></dt><dd>Returns 0 on success. </dd></dl> <p>Reimplemented from <a class="el" href="classDriver.html#ac5c2d2b54949846f4f4f9c3047371b24">Driver</a>.</p> <p>References <a class="el" href="structplayer__ranger__geom.html#a8f8fbdf86759d5a8e8b7bd2cee0b2124">player_ranger_geom::element_poses</a>, and <a class="el" href="structplayer__ranger__geom.html#a6c73870847ec75a190d04ae200042000">player_ranger_geom::element_sizes</a>.</p> </div> </div> <hr/>The documentation for this class was generated from the following files:<ul> <li><a class="el" href="toranger_8h_source.html">toranger.h</a></li> <li>toranger.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>