<!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="#pub-attribs">Public Attributes</a> |
<a href="#pri-attribs">Private Attributes</a> </div>
<div class="headertitle">
<h1>Claser Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="Claser" -->
<p><a class="el" href="classClaser.html" title="Claser implements functions to read data from a laser scanner ROTOSCAN RS4-4 (Leuze corp...">Claser</a> implements functions to read data from a laser scanner ROTOSCAN RS4-4 (Leuze corp.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="RS4Leuze__laser_8h_source.html">RS4Leuze_laser.h</a>></code></p>
<p><a href="classClaser-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"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classClaser.html#a78b58c1c3a9e4f3496e9e03d04cdc34e">Claser</a> (int scan_points)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Opens serial port. <a href="#a78b58c1c3a9e4f3496e9e03d04cdc34e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7b6f5c18195331df5a247601bedf4131"></a><!-- doxytag: member="Claser::~Claser" ref="a7b6f5c18195331df5a247601bedf4131" args="()" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="classClaser.html#a7b6f5c18195331df5a247601bedf4131">~Claser</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3210486733921cd4af6f549f5e60fc41"></a><!-- doxytag: member="Claser::closeLaser" ref="a3210486733921cd4af6f549f5e60fc41" args="()" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classClaser.html#a3210486733921cd4af6f549f5e60fc41">closeLaser</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Closes serial Port and data file. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">unsigned char </td><td class="memItemRight" valign="bottom"><a class="el" href="classClaser.html#a5d90f45d4ff16c2ee5b1394aac9d17fe">readByte</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Reads one byte and updates checksum message. <a href="#a5d90f45d4ff16c2ee5b1394aac9d17fe"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a713e8047ef107a8e7f59200954d69129"></a><!-- doxytag: member="Claser::sync" ref="a713e8047ef107a8e7f59200954d69129" args="()" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classClaser.html#a713e8047ef107a8e7f59200954d69129">sync</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">sync function synchronizes with the start of the laser data <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3e42a52153df590c9fe46f5e3afd6da2"></a><!-- doxytag: member="Claser::writeConfig" ref="a3e42a52153df590c9fe46f5e3afd6da2" args="()" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classClaser.html#a3e42a52153df590c9fe46f5e3afd6da2">writeConfig</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Write configuration parameters to laser scanner device. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classClaser.html#a4a5d477b1ff97811e52de3843ca65f61">scanRead</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">reads one scan and puts it in scanData array <a href="#a4a5d477b1ff97811e52de3843ca65f61"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3a9a63e01d4557a10e0c61e9db8e8429"></a><!-- doxytag: member="Claser::runLaser" ref="a3a9a63e01d4557a10e0c61e9db8e8429" args="()" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classClaser.html#a3a9a63e01d4557a10e0c61e9db8e8429">runLaser</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the scan reading from the laser. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a932eda5a4a72077a2a5d5d26dc72c4d1"></a><!-- doxytag: member="Claser::closeSerial" ref="a932eda5a4a72077a2a5d5d26dc72c4d1" args="()" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classClaser.html#a932eda5a4a72077a2a5d5d26dc72c4d1">closeSerial</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Closes serial Port. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad5996e6ef25a86ebc2cdc82ed94ef2fb"></a><!-- doxytag: member="Claser::openSerial" ref="ad5996e6ef25a86ebc2cdc82ed94ef2fb" args="(bool *laser_ON, int Baud_rate, const char *Port)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classClaser.html#ad5996e6ef25a86ebc2cdc82ed94ef2fb">openSerial</a> (bool *laser_ON, int Baud_rate, const char *Port)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Opens serial Port and get the default paarameters or those given in the .cfg file. <br/></td></tr>
<tr><td colspan="2"><h2><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a74f3b9521267b719f3cf41fc1db041fd"></a><!-- doxytag: member="Claser::scanData" ref="a74f3b9521267b719f3cf41fc1db041fd" args="" -->
<a class="el" href="structRS4Leuze__laser__readings.html">RS4Leuze_laser_readings_t</a> </td><td class="memItemRight" valign="bottom"><b>scanData</b></td></tr>
<tr><td colspan="2"><h2><a name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac0afba00405cbc9ae156fbf66578a40e"></a><!-- doxytag: member="Claser::portName" ref="ac0afba00405cbc9ae156fbf66578a40e" args="" -->
char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classClaser.html#ac0afba00405cbc9ae156fbf66578a40e">portName</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Serial Port where laser is connected. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8242a7f571ee48950a7de68bbce465cd"></a><!-- doxytag: member="Claser::serialFD" ref="a8242a7f571ee48950a7de68bbce465cd" args="" -->
int </td><td class="memItemRight" valign="bottom"><a class="el" href="classClaser.html#a8242a7f571ee48950a7de68bbce465cd">serialFD</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Serial port file descriptor. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af561cf0d18c2a0bbc765944c3242e03b"></a><!-- doxytag: member="Claser::ttyset" ref="af561cf0d18c2a0bbc765944c3242e03b" args="" -->
termios </td><td class="memItemRight" valign="bottom"><a class="el" href="classClaser.html#af561cf0d18c2a0bbc765944c3242e03b">ttyset</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">termios variable to configure serial port <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad7387474886c10c9f262897fef1ed983"></a><!-- doxytag: member="Claser::rfds" ref="ad7387474886c10c9f262897fef1ed983" args="" -->
fd_set </td><td class="memItemRight" valign="bottom"><b>rfds</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aff13ae18e07144fe114a4b552c52b092"></a><!-- doxytag: member="Claser::selectResult" ref="aff13ae18e07144fe114a4b552c52b092" args="" -->
int </td><td class="memItemRight" valign="bottom"><a class="el" href="classClaser.html#aff13ae18e07144fe114a4b552c52b092">selectResult</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Laser <a class="el" href="classMessage.html" title="Reference-counted message objects.">Message</a> fields. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7cc6312cb736271dad99fbb6c121b498"></a><!-- doxytag: member="Claser::byte" ref="a7cc6312cb736271dad99fbb6c121b498" args="" -->
unsigned char </td><td class="memItemRight" valign="bottom"><b>byte</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa26313eab6a49ea3c5a6de4ad323cefa"></a><!-- doxytag: member="Claser::checksum" ref="aa26313eab6a49ea3c5a6de4ad323cefa" args="" -->
unsigned char </td><td class="memItemRight" valign="bottom"><b>checksum</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a63d794c59271ebb294542d9404abdd22"></a><!-- doxytag: member="Claser::option1" ref="a63d794c59271ebb294542d9404abdd22" args="" -->
unsigned char </td><td class="memItemRight" valign="bottom"><b>option1</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5304feff96551eed50cc9982f713db59"></a><!-- doxytag: member="Claser::scan_number" ref="a5304feff96551eed50cc9982f713db59" args="" -->
long unsigned int </td><td class="memItemRight" valign="bottom"><b>scan_number</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad419500ba26ebd22df889d1d71210a07"></a><!-- doxytag: member="Claser::output_start" ref="ad419500ba26ebd22df889d1d71210a07" args="" -->
unsigned int </td><td class="memItemRight" valign="bottom"><b>output_start</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a92435e5c777f645f93e4b506aebda3c9"></a><!-- doxytag: member="Claser::output_stop" ref="a92435e5c777f645f93e4b506aebda3c9" args="" -->
unsigned int </td><td class="memItemRight" valign="bottom"><b>output_stop</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4f2baa4ecc6992e5c988803a0a75c671"></a><!-- doxytag: member="Claser::scanedPoint" ref="a4f2baa4ecc6992e5c988803a0a75c671" args="" -->
unsigned int </td><td class="memItemRight" valign="bottom"><b>scanedPoint</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1a80d415273ab387b97e52312c116e5d"></a><!-- doxytag: member="Claser::controlByte" ref="a1a80d415273ab387b97e52312c116e5d" args="" -->
unsigned char </td><td class="memItemRight" valign="bottom"><b>controlByte</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aade09eb037caf7514781cdac91a23fab"></a><!-- doxytag: member="Claser::points_to_scan" ref="aade09eb037caf7514781cdac91a23fab" args="" -->
unsigned int </td><td class="memItemRight" valign="bottom"><b>points_to_scan</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4d8011b9efe1835877fa5ca220d0f13e"></a><!-- doxytag: member="Claser::tv" ref="a4d8011b9efe1835877fa5ca220d0f13e" args="" -->
struct timeval </td><td class="memItemRight" valign="bottom"><a class="el" href="classClaser.html#a4d8011b9efe1835877fa5ca220d0f13e">tv</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">termios variable time interval <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad2ece4697300b0eed67fc47741c3c2c1"></a><!-- doxytag: member="Claser::timeStamp" ref="ad2ece4697300b0eed67fc47741c3c2c1" args="" -->
timeval </td><td class="memItemRight" valign="bottom"><a class="el" href="classClaser.html#ad2ece4697300b0eed67fc47741c3c2c1">timeStamp</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Time in microseconds resolution. <br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p><a class="el" href="classClaser.html" title="Claser implements functions to read data from a laser scanner ROTOSCAN RS4-4 (Leuze corp...">Claser</a> implements functions to read data from a laser scanner ROTOSCAN RS4-4 (Leuze corp. </p>
<p>) connected to a serial port. </p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a78b58c1c3a9e4f3496e9e03d04cdc34e"></a><!-- doxytag: member="Claser::Claser" ref="a78b58c1c3a9e4f3496e9e03d04cdc34e" args="(int scan_points)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Claser::Claser </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>scan_points</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Opens serial port. </p>
<p>laser.cpp V 2.0 -> RS4Leuze_laser.cpp</p>
<p>Modified by Ernesto Homar Teniente Aviles Date 20 APril 2007 Default constructor. </p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a5d90f45d4ff16c2ee5b1394aac9d17fe"></a><!-- doxytag: member="Claser::readByte" ref="a5d90f45d4ff16c2ee5b1394aac9d17fe" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned char Claser::readByte </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Reads one byte and updates checksum message. </p>
<p>Reads one byte from serialFD and updates checksum. </p>
<p>References <a class="el" href="classClaser.html#a8242a7f571ee48950a7de68bbce465cd">serialFD</a>.</p>
<p>Referenced by <a class="el" href="classClaser.html#a4a5d477b1ff97811e52de3843ca65f61">scanRead()</a>.</p>
</div>
</div>
<a class="anchor" id="a4a5d477b1ff97811e52de3843ca65f61"></a><!-- doxytag: member="Claser::scanRead" ref="a4a5d477b1ff97811e52de3843ca65f61" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int Claser::scanRead </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>reads one scan and puts it in scanData array </p>
<p>scanRead reads a whole message of a laser scan, loads it to scanData vector and prints it to laserDataFile.</p>
<p>If success returns 0 and returns 1 if failure. </p>
<p>References <a class="el" href="group__libplayercommon.html#ga037512b044a9b748088953b8229daf7e">PLAYER_ERROR</a>, <a class="el" href="classClaser.html#a5d90f45d4ff16c2ee5b1394aac9d17fe">readByte()</a>, and <a class="el" href="classClaser.html#a8242a7f571ee48950a7de68bbce465cd">serialFD</a>.</p>
<p>Referenced by <a class="el" href="classClaser.html#a3a9a63e01d4557a10e0c61e9db8e8429">runLaser()</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="RS4Leuze__laser_8h_source.html">RS4Leuze_laser.h</a></li>
<li>RS4Leuze_laser.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>
