Sophie

Sophie

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

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="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 class="current"><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><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_c"></a>- c -</h3><ul>
<li>calib_data
: <a class="el" href="structplayer__imu__data__quat.html#ae01107d8b0b37ee1bc745a33d576dbc7">player_imu_data_quat</a>
, <a class="el" href="structplayer__imu__data__euler.html#aaf5548d2fbe495737955061f42da906f">player_imu_data_euler</a>
, <a class="el" href="structplayerc__imu__t.html#a099749925228accdc84848a057d2dda7">playerc_imu_t</a>
</li>
<li>callback_count
: <a class="el" href="struct__playerc__device__t.html#aec94c56d51ba705ca5828eb5b4dea10a">_playerc_device_t</a>
</li>
<li>CameraProxy()
: <a class="el" href="classPlayerCc_1_1CameraProxy.html#a0b5589150ce7853c7bb6b022a2ebc9fd">PlayerCc::CameraProxy</a>
</li>
<li>CanBusSetup()
: <a class="el" href="classSegwayRMP.html#a7e0037672a31a3bb4d1efdfa54bb7871">SegwayRMP</a>
</li>
<li>capacity
: <a class="el" href="structplayerc__gripper__t.html#a3e7fb12329d7b1c0d0346450cf1df241">playerc_gripper_t</a>
, <a class="el" href="structplayer__gripper__geom.html#ac572495f8921d0defeb51075e144bbc1">player_gripper_geom</a>
</li>
<li>caps
: <a class="el" href="structplayer__audio__mixer__channel__detail.html#aac0e64dce241773b1b35a87e15a8706b">player_audio_mixer_channel_detail</a>
</li>
<li>cells
: <a class="el" href="structplayerc__map__t.html#a7faed215491e70e1747ad4738f8930bf">playerc_map_t</a>
</li>
<li>centre
: <a class="el" href="structplayer__actarray__actuatorgeom.html#a689425acd15cef89f768a78dea43b285">player_actarray_actuatorgeom</a>
</li>
<li>channel
: <a class="el" href="structplayer__blobfinder__color__config.html#a4a637a33b2f06d0c1800242bd4119e1a">player_blobfinder_color_config</a>
</li>
<li>channel_details_list
: <a class="el" href="structplayerc__audio__t.html#a0f6a329fa88356867845ad14b3a5f94b">playerc_audio_t</a>
</li>
<li>channels
: <a class="el" href="structplayer__audio__mixer__channel__list.html#a26cdb787ce42a3c5d0839b51b4242e90">player_audio_mixer_channel_list</a>
</li>
<li>channels_count
: <a class="el" href="structplayer__audio__mixer__channel__list.html#a76f67562cc3f6c5560066b051cdcfad3">player_audio_mixer_channel_list</a>
</li>
<li>charge
: <a class="el" href="structplayerc__power__t.html#a41a173e95820ed515d4b02e89379f24c">playerc_power_t</a>
</li>
<li>charging
: <a class="el" href="structplayer__power__data.html#ab1e42ac8566497478bd3efcd8920b9f5">player_power_data</a>
, <a class="el" href="structplayerc__power__t.html#a89f41db545d02ffd6aaaeccea18daee7">playerc_power_t</a>
</li>
<li>CheckReplace()
: <a class="el" href="classMessageQueue.html#aeed98bb303df8f1e6c03762c45d51556">MessageQueue</a>
</li>
<li>Claser()
: <a class="el" href="classClaser.html#a78b58c1c3a9e4f3496e9e03d04cdc34e">Claser</a>
</li>
<li>Clear()
: <a class="el" href="classPlayerCc_1_1Graphics2dProxy.html#af17131cd0468b042c2a74fc302b63d1a">PlayerCc::Graphics2dProxy</a>
, <a class="el" href="classPlayerCc_1_1Graphics3dProxy.html#a9d5d10f6576667b11398018f0032591d">PlayerCc::Graphics3dProxy</a>
</li>
<li>ClearFilter()
: <a class="el" href="classMessageQueue.html#a12549bcfc89a87bf1259c4c96b7d635e">MessageQueue</a>
</li>
<li>client
: <a class="el" href="struct__playerc__device__t.html#a278782fe8308fa8abdc9bdc31ce82afe">_playerc_device_t</a>
</li>
<li>Close()
: <a class="el" href="classPlayerCc_1_1GripperProxy.html#a305b70b96244c093b0c0814a979d5403">PlayerCc::GripperProxy</a>
</li>
<li>closeLaser()
: <a class="el" href="classClaser.html#a3210486733921cd4af6f549f5e60fc41">Claser</a>
</li>
<li>closeSerial()
: <a class="el" href="classClaser.html#a932eda5a4a72077a2a5d5d26dc72c4d1">Claser</a>
</li>
<li>cmd
: <a class="el" href="structplayer__simulation__cmd.html#af59d9a7b247ffa741dbb090d3c0ce901">player_simulation_cmd</a>
</li>
<li>col
: <a class="el" href="structplayer__map__data.html#aa7a7307f3e0a13c92f6f45c8712dbf8d">player_map_data</a>
</li>
<li>Color()
: <a class="el" href="classPlayerCc_1_1Graphics3dProxy.html#a745e629ada3312abe8bc781099cfabd2">PlayerCc::Graphics3dProxy</a>
</li>
<li>color
: <a class="el" href="structplayer__blobfinder__blob.html#aecde7e13788bfda5ab433b6d2595880e">player_blobfinder_blob</a>
, <a class="el" href="structplayer__blinkenlight__data.html#a40d2ccd02e54c7aaf7bf8cbcb023c810">player_blinkenlight_data</a>
, <a class="el" href="structplayerc__graphics3d__t.html#a7e1e40ebaf08d9fc5a0c063c57962a87">playerc_graphics3d_t</a>
, <a class="el" href="structplayer__blinkenlight__cmd.html#ad179c2d8332a1245be853d940fd2fa66">player_blinkenlight_cmd</a>
, <a class="el" href="structplayer__blinkenlight__cmd__color.html#ab1aed60250bf37fa07de2b84ee29a362">player_blinkenlight_cmd_color</a>
, <a class="el" href="structplayer__graphics2d__cmd__points.html#a5e7e4af7e3582601b605e3de9750e36c">player_graphics2d_cmd_points</a>
, <a class="el" href="structplayer__graphics2d__cmd__polyline.html#acecbf90861bc32ec6cea96f9bead1ec5">player_graphics2d_cmd_polyline</a>
, <a class="el" href="structplayer__graphics2d__cmd__polygon.html#a1319e8be7c5eabf31db03f3a74d9fd8f">player_graphics2d_cmd_polygon</a>
, <a class="el" href="structplayer__graphics3d__cmd__draw.html#aaa80ed9b06e28db764c72087c03f3bb7">player_graphics3d_cmd_draw</a>
, <a class="el" href="structplayerc__graphics2d__t.html#a1e51bcacba8caefcd8181b7a456c5e13">playerc_graphics2d_t</a>
</li>
<li>Color()
: <a class="el" href="classPlayerCc_1_1Graphics2dProxy.html#afcf535436a0e1c0415c2f7cb31f9c4a3">PlayerCc::Graphics2dProxy</a>
</li>
<li>colormode
: <a class="el" href="structplayer__blobfinder__imager__config.html#a79aa954b3af0a17c56163f6b4ca15c9c">player_blobfinder_imager_config</a>
</li>
<li>Compare()
: <a class="el" href="classMessage.html#a311ef732515d9fa851af951a4cf7e12e">Message</a>
</li>
<li>compression
: <a class="el" href="structplayerc__camera__t.html#acbdf36a34a57a4367ff5a97c72615a22">playerc_camera_t</a>
, <a class="el" href="structplayer__camera__data.html#aa5c4ff0aedc44d073477291ed4c4c1c6">player_camera_data</a>
</li>
<li>cond
: <a class="el" href="classMessageQueue.html#a926c7aa691bfa676fc95c7bac068db1c">MessageQueue</a>
</li>
<li>condMutex
: <a class="el" href="classMessageQueue.html#adbdac9cbde00e9c91233177a9f24e10b">MessageQueue</a>
</li>
<li>config
: <a class="el" href="structplayer__ranger__data__rangestamped.html#abf18a1364e9defef4388d7e8175b101f">player_ranger_data_rangestamped</a>
, <a class="el" href="structplayer__ptz__req__generic.html#a5a7c19cf5f9d3469843e1c8df3438984">player_ptz_req_generic</a>
, <a class="el" href="structplayer__ranger__data__intnsstamped.html#a3fdb09f60f1f7e9cbcca0a3d722f8cff">player_ranger_data_intnsstamped</a>
</li>
<li>config_count
: <a class="el" href="structplayer__ptz__req__generic.html#a715757f77e4ed27fd4477487f4afde8a">player_ptz_req_generic</a>
</li>
<li>config_speed
: <a class="el" href="structplayer__actarray__actuatorgeom.html#a1cfe261f41ecfd84e33b5e93bd607c68">player_actarray_actuatorgeom</a>
</li>
<li>ConfigFile()
: <a class="el" href="classConfigFile.html#a9ce259defdfaabeedb2455849ca6bd1e">ConfigFile</a>
</li>
<li>Configure()
: <a class="el" href="classPlayerCc_1_1RangerProxy.html#af3edd3dc264564072571c41655a67932">PlayerCc::RangerProxy</a>
, <a class="el" href="classPlayerCc_1_1LaserProxy.html#abf5173dba8d5350453516217370d4c59">PlayerCc::LaserProxy</a>
</li>
<li>Connected()
: <a class="el" href="classPlayerCc_1_1PlayerClient.html#ae680c636ec2b279a2cef636f1e747bd3">PlayerCc::PlayerClient</a>
</li>
<li>connected
: <a class="el" href="struct__playerc__client__t.html#a16c9520f6923302834f826a3c21a2b97">_playerc_client_t</a>
</li>
<li>ConnectReadSignal()
: <a class="el" href="classPlayerCc_1_1ClientProxy.html#a8d2a82e31f62e3ca94cad558bd7ebcdd">PlayerCc::ClientProxy</a>
</li>
<li>contrast
: <a class="el" href="structplayer__blobfinder__imager__config.html#ae24a8bb7ad0b5f8173f94682a6091d9f">player_blobfinder_imager_config</a>
</li>
<li>Convert()
: <a class="el" href="classFeatureDataHolder.html#adca0125e52e6a994023f6d39cd2effa1">FeatureDataHolder</a>
</li>
<li>count
: <a class="el" href="structplayer__dio__cmd.html#ac432b4e1caa11ce2a8303eae614ef430">player_dio_cmd</a>
, <a class="el" href="structplayer__dio__data.html#a285590a9752b6f44c268effd3112e1a0">player_dio_data</a>
</li>
<li>cov
: <a class="el" href="structplayer__localize__hypoth.html#aeaae3a9df623c1f7aaaae2dbe7e5367e">player_localize_hypoth</a>
, <a class="el" href="structplayer__localize__set__pose.html#ac63cdb55a77d4cb319cb409f5a3a61fb">player_localize_set_pose</a>
</li>
<li>cpu_usage
: <a class="el" href="structplayerc__health__t.html#a6a6472dea44b2dcbe4d6de121fcf17d5">playerc_health_t</a>
, <a class="el" href="structplayer__health__data.html#a216e844af7bc49fa84af56340370efb4">player_health_data</a>
</li>
<li>curr_waypoint
: <a class="el" href="structplayerc__planner__t.html#a3dc64ed428e951da38c02c722ad7695d">playerc_planner_t</a>
</li>
<li>current
: <a class="el" href="structplayer__actarray__current__cmd.html#ac12670944be89556d359b2c7645228a5">player_actarray_current_cmd</a>
, <a class="el" href="structplayer__actarray__actuator.html#a79819eafceaace352a7c0b705eb0923f">player_actarray_actuator</a>
</li>
<li>currents
: <a class="el" href="structplayer__actarray__multi__current__cmd.html#ab2fa8482fb364882592a68766956cdf8">player_actarray_multi_current_cmd</a>
</li>
<li>currents_count
: <a class="el" href="structplayer__actarray__multi__current__cmd.html#aede7cc8d13e5b728429abdd41ddd143e">player_actarray_multi_current_cmd</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>