<!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="tabs2"> <ul class="tablist"> <li class="current"><a href="functions.html"><span>All</span></a></li> <li><a href="functions_func.html"><span>Functions</span></a></li> <li><a href="functions_vars.html"><span>Variables</span></a></li> </ul> </div> <div class="tabs3"> <ul class="tablist"> <li><a href="functions.html#index_a"><span>a</span></a></li> <li><a href="functions_0x62.html#index_b"><span>b</span></a></li> <li><a href="functions_0x63.html#index_c"><span>c</span></a></li> <li><a href="functions_0x64.html#index_d"><span>d</span></a></li> <li><a href="functions_0x65.html#index_e"><span>e</span></a></li> <li><a href="functions_0x66.html#index_f"><span>f</span></a></li> <li><a href="functions_0x67.html#index_g"><span>g</span></a></li> <li><a href="functions_0x68.html#index_h"><span>h</span></a></li> <li><a href="functions_0x69.html#index_i"><span>i</span></a></li> <li><a href="functions_0x6a.html#index_j"><span>j</span></a></li> <li><a href="functions_0x6b.html#index_k"><span>k</span></a></li> <li><a href="functions_0x6c.html#index_l"><span>l</span></a></li> <li><a href="functions_0x6d.html#index_m"><span>m</span></a></li> <li><a href="functions_0x6e.html#index_n"><span>n</span></a></li> <li><a href="functions_0x6f.html#index_o"><span>o</span></a></li> <li><a href="functions_0x70.html#index_p"><span>p</span></a></li> <li><a href="functions_0x71.html#index_q"><span>q</span></a></li> <li class="current"><a href="functions_0x72.html#index_r"><span>r</span></a></li> <li><a href="functions_0x73.html#index_s"><span>s</span></a></li> <li><a href="functions_0x74.html#index_t"><span>t</span></a></li> <li><a href="functions_0x75.html#index_u"><span>u</span></a></li> <li><a href="functions_0x76.html#index_v"><span>v</span></a></li> <li><a href="functions_0x77.html#index_w"><span>w</span></a></li> <li><a href="functions_0x78.html#index_x"><span>x</span></a></li> <li><a href="functions_0x79.html#index_y"><span>y</span></a></li> <li><a href="functions_0x7a.html#index_z"><span>z</span></a></li> <li><a href="functions_0x7e.html#index_~"><span>~</span></a></li> </ul> </div> <div class="contents"> Here is a list of all documented class members with links to the class documentation for each member: <h3><a class="anchor" id="index_r"></a>- r -</h3><ul> <li>radius : <a class="el" href="structplayer__bumper__define.html#afd1eb4e521da570c060b7b5267c3878f">player_bumper_define</a> </li> <li>range : <a class="el" href="structplayer__blobfinder__blob.html#a793f57dafbfe95ef358d1b5249df41e7">player_blobfinder_blob</a> </li> <li>range_res : <a class="el" href="structplayer__ranger__config.html#a09b2a8eb49317bc1b5c17cd7518a150e">player_ranger_config</a> , <a class="el" href="structplayerc__laser__t.html#a2b894984c5896e1917db58d0e28d4a1f">playerc_laser_t</a> , <a class="el" href="structplayer__laser__config.html#a30f2de6bc462f04b86a32d0c5cad80e3">player_laser_config</a> , <a class="el" href="structplayerc__ranger__t.html#a25ede84aa73b54d28d7a91a529119330">playerc_ranger_t</a> </li> <li>RangerProxy() : <a class="el" href="classPlayerCc_1_1RangerProxy.html#a672f6314024a32007de6ee95b6fd3e1d">PlayerCc::RangerProxy</a> </li> <li>ranges : <a class="el" href="structplayer__sonar__data.html#a97fa72a2347ffaf96a81ddd728864c4a">player_sonar_data</a> , <a class="el" href="structplayer__laser__data.html#a1e2f517aecc61c7899243569da434eb5">player_laser_data</a> , <a class="el" href="structplayer__laser__data__scanangle.html#a93073e9e2cd6af92e0b4938e0f1ada99">player_laser_data_scanangle</a> , <a class="el" href="structplayer__ir__data.html#a32bea06f047cc18dbb9d064566a9eefd">player_ir_data</a> , <a class="el" href="structplayer__ranger__data__range.html#a6cb1e56201bede08ae0b924492be07b5">player_ranger_data_range</a> , <a class="el" href="structplayerc__laser__t.html#aabd106cf05b665bccc8171f240909cc6">playerc_laser_t</a> , <a class="el" href="structplayerc__ranger__t.html#ac97e4edd33c9833922feb88f6538af58">playerc_ranger_t</a> </li> <li>ranges_count : <a class="el" href="structplayer__laser__data.html#a764eae32614fe0bd1ff20dac5e8603c4">player_laser_data</a> , <a class="el" href="structplayer__laser__data__scanangle.html#a3334dcd689097f386640515a1a641c17">player_laser_data_scanangle</a> , <a class="el" href="structplayer__ir__data.html#a9c4f4278b36b26c14eab36568bb623b4">player_ir_data</a> , <a class="el" href="structplayer__ranger__data__range.html#a7d7ea701b102521f6e6e2d8ca7fcc33b">player_ranger_data_range</a> , <a class="el" href="structplayerc__ranger__t.html#a85f33c6bbaca7d39f3b7eb027e6311c6">playerc_ranger_t</a> , <a class="el" href="structplayer__sonar__data.html#ab71ad9333032d37c3dcb6e718c785278">player_sonar_data</a> </li> <li>Read() : <a class="el" href="classPlayerCc_1_1PlayerClient.html#af2fa99e62ceb1113d6891dc36dfceecd">PlayerCc::PlayerClient</a> </li> <li>ReadAngle() : <a class="el" href="classConfigFile.html#a6943cb2b881a5730aa5ce140d33cc5b2">ConfigFile</a> </li> <li>ReadBool() : <a class="el" href="classConfigFile.html#ad53021137b439b8dd8148b3654a4c7e5">ConfigFile</a> </li> <li>readByte() : <a class="el" href="classClaser.html#a5d90f45d4ff16c2ee5b1394aac9d17fe">Claser</a> </li> <li>ReadColor() : <a class="el" href="classConfigFile.html#a7f559ca0c3bba329d282317fe49a642f">ConfigFile</a> </li> <li>ReadDeviceAddr() : <a class="el" href="classConfigFile.html#ab3f2b1557d97d5460a3d0ce83def74c8">ConfigFile</a> </li> <li>ReadFilename() : <a class="el" href="classConfigFile.html#aebb20344a10b41981d3ce7786768a836">ConfigFile</a> </li> <li>ReadFloat() : <a class="el" href="classConfigFile.html#a3b8039e2bd5feca4e13cc7337bb963fd">ConfigFile</a> </li> <li>ReadIfWaiting() : <a class="el" href="classPlayerCc_1_1PlayerClient.html#a5950f93871543b416289d66f8eb5b388">PlayerCc::PlayerClient</a> </li> <li>ReadInt() : <a class="el" href="classConfigFile.html#a75f0dc55992cf33d5c63c864fbbd5510">ConfigFile</a> </li> <li>ReadLength() : <a class="el" href="classConfigFile.html#ade134d301468477227368842f3965cd4">ConfigFile</a> </li> <li>ReadString() : <a class="el" href="classConfigFile.html#a5b8c497335c1036b9a865d4c784625c9">ConfigFile</a> </li> <li>ReadTupleAngle() : <a class="el" href="classConfigFile.html#a04bf3b1b117595cfc7a9e5f34a8430d3">ConfigFile</a> </li> <li>ReadTupleColor() : <a class="el" href="classConfigFile.html#af23e0d48bb3aad36a2c5a64792125f1a">ConfigFile</a> </li> <li>ReadTupleFloat() : <a class="el" href="classConfigFile.html#a2c06d1bd93c06e4692c521f2ad57ac0c">ConfigFile</a> </li> <li>ReadTupleInt() : <a class="el" href="classConfigFile.html#a32b7e8338e52e05a7c3e0286d2683aed">ConfigFile</a> </li> <li>ReadTupleLength() : <a class="el" href="classConfigFile.html#ad6c6380b2f40a7865518e791cab17348">ConfigFile</a> </li> <li>ReadTupleString() : <a class="el" href="classConfigFile.html#a1b18b6cabc15d86d5eb2930803faba68">ConfigFile</a> </li> <li>ReceiveThread() : <a class="el" href="classErratic.html#a500b886eb90f16557f2f7fdf0c595ec3">Erratic</a> </li> <li>RecordSample() : <a class="el" href="classPlayerCc_1_1AudioProxy.html#a6b9ccc5c62cd459fa3b5381a5759814a">PlayerCc::AudioProxy</a> </li> <li>RecordWav() : <a class="el" href="classPlayerCc_1_1AudioProxy.html#a2a9166c6b7c98f3a89f68a8cd80ddff7">PlayerCc::AudioProxy</a> </li> <li>red : <a class="el" href="structplayer__color.html#a48a67af1eec4e6b5675109bd981fcdf5">player_color</a> , <a class="el" href="structplayer__pointcloud3d__stereo__element.html#a1541eccd4575d3be010b37572475e6dc">player_pointcloud3d_stereo_element</a> </li> <li>RefCount : <a class="el" href="classQueuePointer.html#af709d845716d474503d0bbf564a97ca3">QueuePointer</a> , <a class="el" href="classMessage.html#af8bcd20674be9b09f4ab73187dd418cc">Message</a> </li> <li>RegisterProperty() : <a class="el" href="classDriver.html#a541cff86aaa91b25bba7f331adff7433">Driver</a> </li> <li>Remove() : <a class="el" href="classMessageQueue.html#ae51d84aa9141368e565f2b482b86b96d">MessageQueue</a> </li> <li>RemoveFileWatch() : <a class="el" href="classDriver.html#a47a8a1f48b22f419809259f4f3bdb5db">Driver</a> </li> <li>replace : <a class="el" href="structplayer__add__replace__rule__req.html#a8f48e97edd87d5afa8e9d7a54972dd02">player_add_replace_rule_req</a> </li> <li>Replace : <a class="el" href="classMessageQueue.html#ad69ab7d8969fc437d7cfa40be01b8fc2">MessageQueue</a> </li> <li>replaceRules : <a class="el" href="classMessageQueue.html#a6b4e1ca9827f50ff13c80aed3011631c">MessageQueue</a> </li> <li>Request() : <a class="el" href="classDevice.html#aeafd1418afc82da4603310b6e35ff3dc">Device</a> </li> <li>RequestBumperConfig() : <a class="el" href="classPlayerCc_1_1BumperProxy.html#a81f4d050f63403043dda7d2aa6e89cef">PlayerCc::BumperProxy</a> </li> <li>RequestConfigure() : <a class="el" href="classPlayerCc_1_1LaserProxy.html#a4dead8192297f4a3c80208f41b4c87a7">PlayerCc::LaserProxy</a> , <a class="el" href="classPlayerCc_1_1RangerProxy.html#a4b6f7910bae06680b1716a7ef4ea9863">PlayerCc::RangerProxy</a> </li> <li>RequestDeviceList() : <a class="el" href="classPlayerCc_1_1PlayerClient.html#ad444618a210e5f9643755b3e69910a59">PlayerCc::PlayerClient</a> </li> <li>RequestGeom() : <a class="el" href="classPlayerCc_1_1RangerProxy.html#afaf7f68d5f30498ce49ba9e1f2e2c6c1">PlayerCc::RangerProxy</a> , <a class="el" href="classPlayerCc_1_1SonarProxy.html#aa5c3ab6a5d1ffe0c474c12c239100c20">PlayerCc::SonarProxy</a> , <a class="el" href="classPlayerCc_1_1LaserProxy.html#a5a95e817f51d0b4adb6fdf051beef309">PlayerCc::LaserProxy</a> , <a class="el" href="classPlayerCc_1_1IrProxy.html#af5a76e405bd9b90ffe2662ddde4cbec1">PlayerCc::IrProxy</a> , <a class="el" href="classPlayerCc_1_1Position1dProxy.html#a69e1df7a24b8e1f0a99cc4dcb37e11aa">PlayerCc::Position1dProxy</a> , <a class="el" href="classPlayerCc_1_1Position2dProxy.html#a12fa91ddc7a193b443c593164bb367d4">PlayerCc::Position2dProxy</a> , <a class="el" href="classPlayerCc_1_1Position3dProxy.html#a213caf437ea59281641b8b5c3be47bf7">PlayerCc::Position3dProxy</a> </li> <li>RequestGeometry() : <a class="el" href="classPlayerCc_1_1ActArrayProxy.html#ac0f99d400adf705603c507d5f7f7c754">PlayerCc::ActArrayProxy</a> , <a class="el" href="classPlayerCc_1_1FiducialProxy.html#a4116b020d8a975f366415648ce435fc7">PlayerCc::FiducialProxy</a> , <a class="el" href="classPlayerCc_1_1LimbProxy.html#a9654519c5ac9b64182a809d00c58f9cd">PlayerCc::LimbProxy</a> , <a class="el" href="classPlayerCc_1_1GripperProxy.html#a22c3d1a9a987e5b0a49ac15d7a20000a">PlayerCc::GripperProxy</a> </li> <li>RequestID() : <a class="el" href="classPlayerCc_1_1LaserProxy.html#a92346a29768ef18f78540caa05b4e974">PlayerCc::LaserProxy</a> </li> <li>RequestMap() : <a class="el" href="classPlayerCc_1_1MapProxy.html#a3897302638d2607102137d44d3a5297e">PlayerCc::MapProxy</a> </li> <li>RequestWaypoints() : <a class="el" href="classPlayerCc_1_1PlannerProxy.html#a07b055dcc37a57cf2fa2c3868d4e403d">PlayerCc::PlannerProxy</a> </li> <li>ResetOdometry() : <a class="el" href="classPlayerCc_1_1Position3dProxy.html#a84229873bdbfa50db422990b0aa54905">PlayerCc::Position3dProxy</a> , <a class="el" href="classPlayerCc_1_1Position1dProxy.html#a6883b05efa79e6371bb38f981fde9264">PlayerCc::Position1dProxy</a> , <a class="el" href="classPlayerCc_1_1Position2dProxy.html#a52cc89aecc5c587ad8f23bed13c554a2">PlayerCc::Position2dProxy</a> </li> <li>ResetOrientation() : <a class="el" href="classPlayerCc_1_1ImuProxy.html#a05c899bed26a18462656d504a8aabf12">PlayerCc::ImuProxy</a> </li> <li>resolution : <a class="el" href="structplayer__laser__data.html#ac89f804301ab07d3d4fdbb87687bce28">player_laser_data</a> , <a class="el" href="structplayerc__map__t.html#add5f19a78e4d5665e02df8837e5726b7">playerc_map_t</a> , <a class="el" href="structplayer__laser__config.html#a45e952dafa9682d01c4580ab2f848497">player_laser_config</a> </li> <li>ret_queue : <a class="el" href="classDriver.html#a75f76dccef5f9e45877df163c984d044">Driver</a> </li> <li>Retrieve() : <a class="el" href="classPlayerCc_1_1GripperProxy.html#a3c27c310cbf8612a93b5b4fbe655040b">PlayerCc::GripperProxy</a> </li> <li>retry_limit : <a class="el" href="struct__playerc__client__t.html#a2a43933140aeee04e3c5e466e98f04e4">_playerc_client_t</a> </li> <li>retry_time : <a class="el" href="struct__playerc__client__t.html#a2fdfd0ee90a3794b25fa6e0fcf35ffc5">_playerc_client_t</a> </li> <li>Rewind() : <a class="el" href="classPlayerCc_1_1LogProxy.html#a57647f5ff6f46b51ef5c480345883655">PlayerCc::LogProxy</a> </li> <li>RFIDProxy() : <a class="el" href="classPlayerCc_1_1RFIDProxy.html#a3b3060eae3ad9c677cd50ae6e96bcfbf">PlayerCc::RFIDProxy</a> </li> <li>right : <a class="el" href="structplayer__blobfinder__blob.html#a734b7545f2423c39751c2482429eb97b">player_blobfinder_blob</a> </li> <li>rmax : <a class="el" href="structplayer__blobfinder__color__config.html#aca2204b3068e2d6b208cc692722c5a63">player_blobfinder_color_config</a> </li> <li>rmin : <a class="el" href="structplayer__blobfinder__color__config.html#a16e7cce6a5922feceb590bdef6fa5d15">player_blobfinder_color_config</a> </li> <li>rmp2d_data : <a class="el" href="classSegwayRMP400.html#a8b93e866d7921c5300c052d3ce797c3c">SegwayRMP400</a> </li> <li>rmp3d_data : <a class="el" href="classSegwayRMP400.html#aade762d073d01b7142d47af781726793">SegwayRMP400</a> </li> <li>robot : <a class="el" href="structplayer__devaddr.html#a5bfc4826407c3a01f4ae884ffcef00c7">player_devaddr</a> </li> <li>robot_pose : <a class="el" href="structplayerc__laser__t.html#af885a7e55642a0dd75d1d521d5e1ed4f">playerc_laser_t</a> </li> <li>row : <a class="el" href="structplayer__map__data.html#afbf230588c0025517a5f8bf611e0e249">player_map_data</a> </li> <li>Run() : <a class="el" href="classPlayerCc_1_1PlayerClient.html#a82b774b1026db32446d5a4a15c7667ab">PlayerCc::PlayerClient</a> </li> <li>runLaser() : <a class="el" href="classClaser.html#a3a9a63e01d4557a10e0c61e9db8e8429">Claser</a> </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>