<!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="#pri-methods">Private Member Functions</a> | <a href="#pri-attribs">Private Attributes</a> </div> <div class="headertitle"> <h1>lms400_cola Class Reference</h1> </div> </div> <div class="contents"> <!-- doxytag: class="lms400_cola" --> <p><a href="classlms400__cola-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="a4840536ccb29dd9fd9679c545860807f"></a><!-- doxytag: member="lms400_cola::lms400_cola" ref="a4840536ccb29dd9fd9679c545860807f" args="(const char *host, int port, int debug_mode)" --> </td><td class="memItemRight" valign="bottom"><b>lms400_cola</b> (const char *host, int port, int debug_mode)</td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a20f501c0821d18a48e82f10cd6b57453"></a><!-- doxytag: member="lms400_cola::Connect" ref="a20f501c0821d18a48e82f10cd6b57453" args="()" --> int </td><td class="memItemRight" valign="bottom"><b>Connect</b> ()</td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a771dc476146b76ea8f06e7732082559e"></a><!-- doxytag: member="lms400_cola::Disconnect" ref="a771dc476146b76ea8f06e7732082559e" args="()" --> int </td><td class="memItemRight" valign="bottom"><b>Disconnect</b> ()</td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2bfe9a0e237363bd6eed8e631848d334"></a><!-- doxytag: member="lms400_cola::SetAngularResolution" ref="a2bfe9a0e237363bd6eed8e631848d334" args="(const char *password, float ang_res, float angle_start, float angle_range)" --> int </td><td class="memItemRight" valign="bottom"><b>SetAngularResolution</b> (const char *password, float ang_res, float angle_start, float angle_range)</td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9f55f59908e9e21f2e68b2c5a4703a5d"></a><!-- doxytag: member="lms400_cola::SetScanningFrequency" ref="a9f55f59908e9e21f2e68b2c5a4703a5d" args="(const char *password, float freq, float angle_start, float angle_range)" --> int </td><td class="memItemRight" valign="bottom"><b>SetScanningFrequency</b> (const char *password, float freq, float angle_start, float angle_range)</td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1c5637a07eeb32d3f4a2f493d1cd5627"></a><!-- doxytag: member="lms400_cola::SetResolutionAndFrequency" ref="a1c5637a07eeb32d3f4a2f493d1cd5627" args="(float freq, float ang_res, float angle_start, float angle_range)" --> int </td><td class="memItemRight" valign="bottom"><b>SetResolutionAndFrequency</b> (float freq, float ang_res, float angle_start, float angle_range)</td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aed870bce104b52c36f2a85c2023d2c5c"></a><!-- doxytag: member="lms400_cola::StartMeasurement" ref="aed870bce104b52c36f2a85c2023d2c5c" args="(bool intensity=true)" --> int </td><td class="memItemRight" valign="bottom"><b>StartMeasurement</b> (bool intensity=true)</td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3e58ad2415adb887de7236b0327f5c26"></a><!-- doxytag: member="lms400_cola::ReadMeasurement" ref="a3e58ad2415adb887de7236b0327f5c26" args="()" --> <a class="el" href="structplayer__laser__data.html">player_laser_data</a> </td><td class="memItemRight" valign="bottom"><b>ReadMeasurement</b> ()</td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a63b96f90d9262da147e2a4cda43df63d"></a><!-- doxytag: member="lms400_cola::StopMeasurement" ref="a63b96f90d9262da147e2a4cda43df63d" args="()" --> int </td><td class="memItemRight" valign="bottom"><b>StopMeasurement</b> ()</td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aacc71191dfbf528eedd6bf1febea1403"></a><!-- doxytag: member="lms400_cola::SetUserLevel" ref="aacc71191dfbf528eedd6bf1febea1403" args="(int8_t userlevel, const char *password)" --> int </td><td class="memItemRight" valign="bottom"><b>SetUserLevel</b> (int8_t userlevel, const char *password)</td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a92ab59e7fb9cdd946cc74a48a7e54a64"></a><!-- doxytag: member="lms400_cola::GetMACAddress" ref="a92ab59e7fb9cdd946cc74a48a7e54a64" args="(char **macadress)" --> int </td><td class="memItemRight" valign="bottom"><b>GetMACAddress</b> (char **macadress)</td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a13f54d1d6f0872ba44f48bead69d0c36"></a><!-- doxytag: member="lms400_cola::SetIP" ref="a13f54d1d6f0872ba44f48bead69d0c36" args="(char *ip)" --> int </td><td class="memItemRight" valign="bottom"><b>SetIP</b> (char *ip)</td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5f62c7de5eb68e33564652e04b69d037"></a><!-- doxytag: member="lms400_cola::SetGateway" ref="a5f62c7de5eb68e33564652e04b69d037" args="(char *gw)" --> int </td><td class="memItemRight" valign="bottom"><b>SetGateway</b> (char *gw)</td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1ebf6ba5235fc818f1008c1e90ecb166"></a><!-- doxytag: member="lms400_cola::SetNetmask" ref="a1ebf6ba5235fc818f1008c1e90ecb166" args="(char *mask)" --> int </td><td class="memItemRight" valign="bottom"><b>SetNetmask</b> (char *mask)</td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af524d0e93e6c76fcad5bdb699c24b7f5"></a><!-- doxytag: member="lms400_cola::SetPort" ref="af524d0e93e6c76fcad5bdb699c24b7f5" args="(uint16_t port)" --> int </td><td class="memItemRight" valign="bottom"><b>SetPort</b> (uint16_t port)</td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae05e2e63eab47616015d907b11e58132"></a><!-- doxytag: member="lms400_cola::ResetDevice" ref="ae05e2e63eab47616015d907b11e58132" args="()" --> int </td><td class="memItemRight" valign="bottom"><b>ResetDevice</b> ()</td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a677ea1e6bc1525f3e067f9eb737ca711"></a><!-- doxytag: member="lms400_cola::TerminateConfiguration" ref="a677ea1e6bc1525f3e067f9eb737ca711" args="()" --> int </td><td class="memItemRight" valign="bottom"><b>TerminateConfiguration</b> ()</td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acaaaaacd08599404e7e411028dba1ac7"></a><!-- doxytag: member="lms400_cola::SendCommand" ref="acaaaaacd08599404e7e411028dba1ac7" args="(const char *cmd)" --> int </td><td class="memItemRight" valign="bottom"><b>SendCommand</b> (const char *cmd)</td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4e170b9e3cf63eb0a2ab3546cf496937"></a><!-- doxytag: member="lms400_cola::ReadResult" ref="a4e170b9e3cf63eb0a2ab3546cf496937" args="()" --> int </td><td class="memItemRight" valign="bottom"><b>ReadResult</b> ()</td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa3d598102d1f3755608c034d82b76fda"></a><!-- doxytag: member="lms400_cola::ReadAnswer" ref="aa3d598102d1f3755608c034d82b76fda" args="()" --> int </td><td class="memItemRight" valign="bottom"><b>ReadAnswer</b> ()</td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0ae779811f6753cd6bb30e1906db3151"></a><!-- doxytag: member="lms400_cola::ReadConfirmationAndAnswer" ref="a0ae779811f6753cd6bb30e1906db3151" args="()" --> int </td><td class="memItemRight" valign="bottom"><b>ReadConfirmationAndAnswer</b> ()</td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac51f53f6fbbb848f28cece3723b35053"></a><!-- doxytag: member="lms400_cola::EnableRIS" ref="ac51f53f6fbbb848f28cece3723b35053" args="(int onoff)" --> int </td><td class="memItemRight" valign="bottom"><b>EnableRIS</b> (int onoff)</td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5c4fc5cbf349f75af1723fd62e4dcfec"></a><!-- doxytag: member="lms400_cola::GetConfiguration" ref="a5c4fc5cbf349f75af1723fd62e4dcfec" args="()" --> <a class="el" href="structplayer__laser__config.html">player_laser_config</a> </td><td class="memItemRight" valign="bottom"><b>GetConfiguration</b> ()</td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2363731c5f8dd7c1da82ec15542f74d5"></a><!-- doxytag: member="lms400_cola::SetMeanFilterParameters" ref="a2363731c5f8dd7c1da82ec15542f74d5" args="(int num_scans)" --> int </td><td class="memItemRight" valign="bottom"><b>SetMeanFilterParameters</b> (int num_scans)</td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8df0479d4958c37d8ba7e0811fb34849"></a><!-- doxytag: member="lms400_cola::SetRangeFilterParameters" ref="a8df0479d4958c37d8ba7e0811fb34849" args="(float *ranges)" --> int </td><td class="memItemRight" valign="bottom"><b>SetRangeFilterParameters</b> (float *ranges)</td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1c00f6b14871f140c598ce6656706814"></a><!-- doxytag: member="lms400_cola::EnableFilters" ref="a1c00f6b14871f140c598ce6656706814" args="(int filter_mask)" --> int </td><td class="memItemRight" valign="bottom"><b>EnableFilters</b> (int filter_mask)</td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a09f864b33e250e55313a694244ad7d65"></a><!-- doxytag: member="lms400_cola::ParseIP" ref="a09f864b33e250e55313a694244ad7d65" args="(char *ip)" --> unsigned char * </td><td class="memItemRight" valign="bottom"><b>ParseIP</b> (char *ip)</td></tr> <tr><td colspan="2"><h2><a name="pri-methods"></a> Private Member Functions</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad967d6af76540702ff4e97586aab0e96"></a><!-- doxytag: member="lms400_cola::assemblecommand" ref="ad967d6af76540702ff4e97586aab0e96" args="(unsigned char *command, int len)" --> int </td><td class="memItemRight" valign="bottom"><b>assemblecommand</b> (unsigned char *command, int len)</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="a71a8c44c368cc2e16ec5bbb9b99fa3ff"></a><!-- doxytag: member="lms400_cola::hostname" ref="a71a8c44c368cc2e16ec5bbb9b99fa3ff" args="" --> const char * </td><td class="memItemRight" valign="bottom"><b>hostname</b></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acc4d4cdd1f6e33274bb7f09018c4a5c3"></a><!-- doxytag: member="lms400_cola::sockfd" ref="acc4d4cdd1f6e33274bb7f09018c4a5c3" args="" --> int </td><td class="memItemRight" valign="bottom"><b>sockfd</b></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a50ce60a1564d39d82f35705b27cd5f71"></a><!-- doxytag: member="lms400_cola::portno" ref="a50ce60a1564d39d82f35705b27cd5f71" args="" --> int </td><td class="memItemRight" valign="bottom"><b>portno</b></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa9ef0e4d47fe6d5fb3981c1c237c05f0"></a><!-- doxytag: member="lms400_cola::n" ref="aa9ef0e4d47fe6d5fb3981c1c237c05f0" args="" --> int </td><td class="memItemRight" valign="bottom"><b>n</b></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="adcc65eb4bf3e18a261041e1c8182d9e3"></a><!-- doxytag: member="lms400_cola::serv_addr" ref="adcc65eb4bf3e18a261041e1c8182d9e3" args="" --> struct sockaddr_in </td><td class="memItemRight" valign="bottom"><b>serv_addr</b></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4d39c1d0a093373821d26ea8339b4d93"></a><!-- doxytag: member="lms400_cola::server" ref="a4d39c1d0a093373821d26ea8339b4d93" args="" --> struct hostent * </td><td class="memItemRight" valign="bottom"><b>server</b></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab107f27c6810382642355740b5e2887f"></a><!-- doxytag: member="lms400_cola::verbose" ref="ab107f27c6810382642355740b5e2887f" args="" --> int </td><td class="memItemRight" valign="bottom"><b>verbose</b></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab55250576e0507e34ab3c8f344d63c54"></a><!-- doxytag: member="lms400_cola::ExtendedRIS" ref="ab55250576e0507e34ab3c8f344d63c54" args="" --> int </td><td class="memItemRight" valign="bottom"><b>ExtendedRIS</b></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a302f70ae1ab4046a80ad06a76057d2d7"></a><!-- doxytag: member="lms400_cola::MeanFilterNumScans" ref="a302f70ae1ab4046a80ad06a76057d2d7" args="" --> int </td><td class="memItemRight" valign="bottom"><b>MeanFilterNumScans</b></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac5aab0f90bb4c34de75746e2d28725be"></a><!-- doxytag: member="lms400_cola::RangeFilterTopLimit" ref="ac5aab0f90bb4c34de75746e2d28725be" args="" --> float </td><td class="memItemRight" valign="bottom"><b>RangeFilterTopLimit</b></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a57fcc0a690639f94097b0c3069c9677f"></a><!-- doxytag: member="lms400_cola::RangeFilterBottomLimit" ref="a57fcc0a690639f94097b0c3069c9677f" args="" --> float </td><td class="memItemRight" valign="bottom"><b>RangeFilterBottomLimit</b></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4a402d50fcdcf9a84b8cdae9cd98d298"></a><!-- doxytag: member="lms400_cola::FilterMask" ref="a4a402d50fcdcf9a84b8cdae9cd98d298" args="" --> int </td><td class="memItemRight" valign="bottom"><b>FilterMask</b></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a579d3c63b2d8654344bda9b7402cc10f"></a><!-- doxytag: member="lms400_cola::Configuration" ref="a579d3c63b2d8654344bda9b7402cc10f" args="" --> <a class="el" href="structplayer__laser__config.html">player_laser_config</a> </td><td class="memItemRight" valign="bottom"><b>Configuration</b></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a663f986ddcbf4ea4fe0d7cd580d189c5"></a><!-- doxytag: member="lms400_cola::buffer" ref="a663f986ddcbf4ea4fe0d7cd580d189c5" args="[4096]" --> unsigned char </td><td class="memItemRight" valign="bottom"><b>buffer</b> [4096]</td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8af13f21fb361dd05b23211e9d372fcc"></a><!-- doxytag: member="lms400_cola::bufferlength" ref="a8af13f21fb361dd05b23211e9d372fcc" args="" --> unsigned int </td><td class="memItemRight" valign="bottom"><b>bufferlength</b></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab5b3f915b9115f53b680c22887d176df"></a><!-- doxytag: member="lms400_cola::command" ref="ab5b3f915b9115f53b680c22887d176df" args="[BUF_SIZE]" --> unsigned char </td><td class="memItemRight" valign="bottom"><b>command</b> [BUF_SIZE]</td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac5a592ff5f4454dc56ecdf41ce5cdc1c"></a><!-- doxytag: member="lms400_cola::commandlength" ref="ac5a592ff5f4454dc56ecdf41ce5cdc1c" args="" --> int </td><td class="memItemRight" valign="bottom"><b>commandlength</b></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa584d743be4d5ea8b80a536d41072c7b"></a><!-- doxytag: member="lms400_cola::MeasurementQueue" ref="aa584d743be4d5ea8b80a536d41072c7b" args="" --> std::vector<br class="typebreak"/> < <a class="el" href="structMeasurementQueueElement__t.html">MeasurementQueueElement_t</a> > * </td><td class="memItemRight" valign="bottom"><b>MeasurementQueue</b></td></tr> </table> <hr/>The documentation for this class was generated from the following files:<ul> <li><a class="el" href="lms400__cola_8h_source.html">lms400_cola.h</a></li> <li>lms400_cola.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>