Sophie

Sophie

distrib > Fedora > 14 > x86_64 > media > updates > by-pkgid > 727fa15453fcace956b835e2377d4269 > files > 635

player-doc-3.0.2-5.fc14.noarch.rpm

<!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&nbsp;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&nbsp;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="headertitle">
<h1>readlog<br/>
<small>
[<a class="el" href="group__drivers.html">Drivers</a>]</small>
</h1>  </div>
</div>
<div class="contents">

<p>Playback of logged data.  
<a href="#_details">More...</a></p>
<table class="memberdecls">
</table>
<p>Playback of logged data. </p>
<p>The readlog driver can be used to replay data stored in a log file. This is particularly useful for debugging client programs, since users may run their clients against the same data set over and over again. Suitable log files can be generated using the <a class="el" href="group__driver__writelog.html">writelog</a> driver. The format for the log file can be found in the <a class="el" href="group__tutorial__datalog.html">data logging tutorial</a>.</p>
<p>See below for an example configuration file; note that the device id's specified in the provides field must match those stored in the log file (i.e., data logged as "position2d:0" must also be read back as "position2d:0").</p>
<p>For help in controlling playback, try <a class="el" href="group__util__playervcr.html">playervcr</a>. Note that you must declare a <a class="el" href="group__interface__log.html">log</a> device to allow playback control.</p>
<dl class="user"><dt><b>Compile-time dependencies</b></dt><dd></dd></dl>
<ul>
<li>none</li>
</ul>
<dl class="user"><dt><b>Provides</b></dt><dd></dd></dl>
<p>The readlog driver can provide the following device interfaces.</p>
<ul>
<li><a class="el" href="group__interface__laser.html">laser</a></li>
<li><a class="el" href="group__interface__ranger.html">ranger</a></li>
<li><a class="el" href="group__interface__position2d.html">position2d</a></li>
<li><a class="el" href="group__interface__sonar.html">sonar</a></li>
<li><a class="el" href="group__interface__wifi.html">wifi</a></li>
<li><a class="el" href="group__interface__wsn.html">wsn</a></li>
<li><a class="el" href="group__interface__imu.html">imu</a></li>
<li><a class="el" href="group__interface__pointcloud3d.html">pointcloud3d</a></li>
<li><a class="el" href="group__interface__opaque.html">opaque</a></li>
<li><a class="el" href="group__interface__ptz.html">ptz</a></li>
<li><a class="el" href="group__interface__actarray.html">actarray</a></li>
<li><a class="el" href="group__interface__fiducial.html">fiducial</a></li>
<li><a class="el" href="group__interface__blobfinder.html">blobfinder</a></li>
<li><a class="el" href="group__interface__camera.html">camera</a></li>
<li><a class="el" href="group__interface__gps.html">gps</a></li>
<li><a class="el" href="group__interface__joystick.html">joystick</a></li>
<li><a class="el" href="group__interface__position3d.html">position3d</a></li>
<li><a class="el" href="group__interface__power.html">power</a></li>
<li><a class="el" href="group__interface__dio.html">dio</a></li>
<li><a class="el" href="group__interface__aio.html">aio</a></li>
</ul>
<p>The driver also provides an interface for controlling the playback:</p>
<ul>
<li><a class="el" href="group__interface__log.html">log</a></li>
</ul>
<dl class="user"><dt><b>Requires</b></dt><dd></dd></dl>
<ul>
<li>none</li>
</ul>
<dl class="user"><dt><b>Configuration requests</b></dt><dd></dd></dl>
<ul>
<li>PLAYER_LOG_SET_READ_STATE_REQ</li>
<li>PLAYER_LOG_GET_STATE_REQ</li>
<li>PLAYER_LOG_SET_READ_REWIND_REQ</li>
</ul>
<dl class="user"><dt><b>Configuration file options</b></dt><dd></dd></dl>
<ul>
<li>filename (filename)<ul>
<li>Default: NULL</li>
<li>The log file to play back.</li>
</ul>
</li>
<li>speed (float)<ul>
<li>Default: 1.0</li>
<li>Playback speed; 1.0 is real-time</li>
</ul>
</li>
<li>autoplay (integer)<ul>
<li>Default: 1</li>
<li>Begin playing back log data when first client subscribes (as opposed to waiting for the client to tell the <a class="el" href="group__interface__log.html">log</a> device to play).</li>
</ul>
</li>
<li>autorewind (integer)<ul>
<li>Default: 0</li>
<li>Automatically rewind and play the log file again when the end is reached (as opposed to not producing any more data).</li>
</ul>
</li>
</ul>
<dl class="user"><dt><b>Example</b></dt><dd></dd></dl>
<div class="fragment"><pre class="fragment">

# Play back odometry and laser data at twice real-time from "mydata.log"
driver
(
  name "readlog"
  filename "mydata.log"
  provides ["position2d:0" "laser:0" "log:0"]
  speed 2.0
)
</pre></div><dl class="author"><dt><b>Author:</b></dt><dd>Andrew Howard, Radu Bogdan Rusu, Rich Mattes </dd></dl>
</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>