<!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> </div>
<div class="headertitle">
<h1>LaserTransform Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="LaserTransform" --><!-- doxytag: inherits="Driver" --><div class="dynheader">
Inheritance diagram for LaserTransform:</div>
<div class="dyncontent">
<div class="center">
<img src="classLaserTransform.png" usemap="#LaserTransform_map" alt=""/>
<map id="LaserTransform_map" name="LaserTransform_map">
<area href="classDriver.html" alt="Driver" shape="rect" coords="0,0,101,24"/>
</map>
</div>
<p><a href="classLaserTransform-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="a289a1123299cbaddc5ced42e7a4e3980"></a><!-- doxytag: member="LaserTransform::LaserTransform" ref="a289a1123299cbaddc5ced42e7a4e3980" args="(ConfigFile *cf, int section)" -->
</td><td class="memItemRight" valign="bottom"><b>LaserTransform</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="classLaserTransform.html#ad85a020e370ec75e3977bed61a0624f7">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="#ad85a020e370ec75e3977bed61a0624f7"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classLaserTransform.html#aa3c5273497a2e440f689b9e5dced38b3">Setup</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Initialize the driver. <a href="#aa3c5273497a2e440f689b9e5dced38b3"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classLaserTransform.html#a069f34add7646ae39ce850dbd06c6cc7">Shutdown</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Finalize the driver. <a href="#a069f34add7646ae39ce850dbd06c6cc7"></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="a99b3ec3f09e722949b38a4a18529bdde"></a><!-- doxytag: member="LaserTransform::UpdateLaser" ref="a99b3ec3f09e722949b38a4a18529bdde" args="(player_laser_data_t *data)=0" -->
virtual int </td><td class="memItemRight" valign="bottom"><b>UpdateLaser</b> (<a class="el" href="structplayer__laser__data.html">player_laser_data_t</a> *data)=0</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a71a06cfce74cc432c960fc10ac6b323d"></a><!-- doxytag: member="LaserTransform::HandleRequests" ref="a71a06cfce74cc432c960fc10ac6b323d" args="()" -->
int </td><td class="memItemRight" valign="bottom"><b>HandleRequests</b> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8f61889a4783ca40936313a6ad01bddb"></a><!-- doxytag: member="LaserTransform::HandleGetGeom" ref="a8f61889a4783ca40936313a6ad01bddb" args="(void *client, void *req, int reqlen)" -->
void </td><td class="memItemRight" valign="bottom"><b>HandleGetGeom</b> (void *client, void *req, int reqlen)</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="a89cebd722fee4de66a547a406b2d2035"></a><!-- doxytag: member="LaserTransform::laser_device" ref="a89cebd722fee4de66a547a406b2d2035" args="" -->
<a class="el" href="classDevice.html">Device</a> * </td><td class="memItemRight" valign="bottom"><b>laser_device</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8e5f9200ecd3ccbcb402e0508e227e79"></a><!-- doxytag: member="LaserTransform::laser_addr" ref="a8e5f9200ecd3ccbcb402e0508e227e79" args="" -->
<a class="el" href="structplayer__devaddr.html">player_devaddr_t</a> </td><td class="memItemRight" valign="bottom"><b>laser_addr</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a33b99bec98375324d07bf91892d74a9e"></a><!-- doxytag: member="LaserTransform::laser_timestamp" ref="a33b99bec98375324d07bf91892d74a9e" args="" -->
struct timeval </td><td class="memItemRight" valign="bottom"><b>laser_timestamp</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac96d5ef01e783b270089306816a52934"></a><!-- doxytag: member="LaserTransform::data" ref="ac96d5ef01e783b270089306816a52934" args="" -->
<a class="el" href="structplayer__laser__data.html">player_laser_data_t</a> </td><td class="memItemRight" valign="bottom"><b>data</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0d785ba0e1f3f1c3b5c6604f733ba75a"></a><!-- doxytag: member="LaserTransform::time" ref="a0d785ba0e1f3f1c3b5c6604f733ba75a" args="" -->
struct timeval </td><td class="memItemRight" valign="bottom"><b>time</b></td></tr>
</table>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ad85a020e370ec75e3977bed61a0624f7"></a><!-- doxytag: member="LaserTransform::ProcessMessage" ref="ad85a020e370ec75e3977bed61a0624f7" args="(QueuePointer &resp_queue, player_msghdr *hdr, void *data)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int LaserTransform::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="structplayer__devaddr.html#a7514f8e66c9532d235cc4258a7102af5">player_devaddr::host</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__interface__laser.html#ga99b20671325991998de43dcbbf213ea5">PLAYER_LASER_DATA_SCAN</a>, <a class="el" href="group__message__types.html#ga57872b03daef439c29a81f0aba7208b5">PLAYER_MSGTYPE_DATA</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>, <a class="el" href="classDriver.html#a75f76dccef5f9e45877df163c984d044">Driver::ret_queue</a>, <a class="el" href="structplayer__msghdr.html#a27ef3166ee2eacc5e694e5a20f6fe5b6">player_msghdr::size</a>, and <a class="el" href="structplayer__msghdr.html#aeba88246e5ba9d3d6c1f2b60c329352b">player_msghdr::subtype</a>.</p>
</div>
</div>
<a class="anchor" id="aa3c5273497a2e440f689b9e5dced38b3"></a><!-- doxytag: member="LaserTransform::Setup" ref="aa3c5273497a2e440f689b9e5dced38b3" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int LaserTransform::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="classDriver.html#a98fc106a6ad39263aa769b37bd58905c">Driver::device_addr</a>, <a class="el" href="classDevice.html#a23253859a221d3e66fbd67e8f440132f">Device::MatchDeviceAddress()</a>, <a class="el" href="group__libplayercommon.html#ga037512b044a9b748088953b8229daf7e">PLAYER_ERROR</a>, and <a class="el" href="classDevice.html#af98df4944ecf9090d0c08749a7765336">Device::Subscribe()</a>.</p>
</div>
</div>
<a class="anchor" id="a069f34add7646ae39ce850dbd06c6cc7"></a><!-- doxytag: member="LaserTransform::Shutdown" ref="a069f34add7646ae39ce850dbd06c6cc7" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int LaserTransform::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="classDriver.html#a125eab00b72ad55885162aef7024e09b">Driver::InQueue</a>, and <a class="el" href="classDevice.html#a9f1e6c11baba44692a2e1f502d284201">Device::Unsubscribe()</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="lasertransform_8h_source.html">lasertransform.h</a></li>
<li>lasertransform.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
>
162
