Sophie

Sophie

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

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>Message types<br/>
<small>
[<a class="el" href="group__message__basics.html">Messaging basics</a>]</small>
</h1>  </div>
</div>
<div class="contents">

<p>The Player message types.  
<a href="#_details">More...</a></p>
<table class="memberdecls">
<tr><td colspan="2"><p><a class="anchor" id="amgrpd41d8cd98f00b204e9800998ecf8427e"></a> </p>
<br/><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__message__types.html#ga57872b03daef439c29a81f0aba7208b5">PLAYER_MSGTYPE_DATA</a>&nbsp;&nbsp;&nbsp;1</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">A data message.  <a href="#ga57872b03daef439c29a81f0aba7208b5"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__message__types.html#gaf8fb5087b5a1f4ec631034e71dec0f3d">PLAYER_MSGTYPE_CMD</a>&nbsp;&nbsp;&nbsp;2</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">A command message.  <a href="#gaf8fb5087b5a1f4ec631034e71dec0f3d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__message__types.html#ga59ed953188471436df98bfc3adf0f457">PLAYER_MSGTYPE_REQ</a>&nbsp;&nbsp;&nbsp;3</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">A request message.  <a href="#ga59ed953188471436df98bfc3adf0f457"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__message__types.html#ga312e72e1417096125470061385979696">PLAYER_MSGTYPE_RESP_ACK</a>&nbsp;&nbsp;&nbsp;4</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">A positive response message.  <a href="#ga312e72e1417096125470061385979696"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__message__types.html#ga5bf6a8dfdb85327b655811823824f34a">PLAYER_MSGTYPE_SYNCH</a>&nbsp;&nbsp;&nbsp;5</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">A synch message.  <a href="#ga5bf6a8dfdb85327b655811823824f34a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__message__types.html#gae80fbeee8ef3da0e6f78ec1a18613750">PLAYER_MSGTYPE_RESP_NACK</a>&nbsp;&nbsp;&nbsp;6</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">A negative response message.  <a href="#gae80fbeee8ef3da0e6f78ec1a18613750"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>The Player message types. </p>
<hr/><h2>Define Documentation</h2>
<a class="anchor" id="gaf8fb5087b5a1f4ec631034e71dec0f3d"></a><!-- doxytag: member="player.h::PLAYER_MSGTYPE_CMD" ref="gaf8fb5087b5a1f4ec631034e71dec0f3d" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define PLAYER_MSGTYPE_CMD&nbsp;&nbsp;&nbsp;2</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>A command message. </p>
<p>Such messages are asynchronously published to devices, and are usually used to change some aspect of the device's state. </p>

<p>Referenced by <a class="el" href="classSegwayRMP400.html#a93f9e247bb5689d176e069c2adff3e1d">SegwayRMP400::HandlePosition2DCmd()</a>, <a class="el" href="classSegwayRMP400.html#acc75b9921b519fbf42577452a7ae618c">SegwayRMP400::HandlePosition3DCmd()</a>, <a class="el" href="classwbr914.html#ace8ddb319d524ee9137f150d3e03358b">wbr914::ProcessMessage()</a>, <a class="el" href="classSphereDriver.html#aa28d5b13e311c66f663c1f68f4b09ce4">SphereDriver::ProcessMessage()</a>, <a class="el" href="classsnd.html#a92897857622d982630d9d93104fd3b42">snd::ProcessMessage()</a>, <a class="el" href="classSegwayRMP400.html#a349a66282dd9c799c541014713d2cec4">SegwayRMP400::ProcessMessage()</a>, <a class="el" href="classSegwayRMP.html#a17e359d0e45f05a98a0891ffab1f2731">SegwayRMP::ProcessMessage()</a>, <a class="el" href="classRFLEX.html#ac7e6af9460ce66489b3cdb094950dbe0">RFLEX::ProcessMessage()</a>, <a class="el" href="classP2OS.html#a91bda6c36ac50b99c6cf4a3f9258cb8c">P2OS::ProcessMessage()</a>, <a class="el" href="classKhepera.html#a7677b4bb9f6eb25531b7c418935ba9f1">Khepera::ProcessMessage()</a>, <a class="el" href="classGarciaDriver.html#af0f620f101f28c478f3623d308247adf">GarciaDriver::ProcessMessage()</a>, <a class="el" href="classErratic.html#aa5efa738ad74d1bd6e6e053459f395a9">Erratic::ProcessMessage()</a>, <a class="el" href="classER.html#a12a52473e8b394db5147bb9bc0624dea">ER::ProcessMessage()</a>, <a class="el" href="classClodBuster.html#aae4c6405f68dba4402aea3d95e641c4f">ClodBuster::ProcessMessage()</a>, and <a class="el" href="classAlsa.html#a7ed88e541c2471cc7bb1cebda8025e41">Alsa::ProcessMessage()</a>.</p>

</div>
</div>
<a class="anchor" id="ga57872b03daef439c29a81f0aba7208b5"></a><!-- doxytag: member="player.h::PLAYER_MSGTYPE_DATA" ref="ga57872b03daef439c29a81f0aba7208b5" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define PLAYER_MSGTYPE_DATA&nbsp;&nbsp;&nbsp;1</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>A data message. </p>
<p>Such messages are asynchronously published from devices, and are usually used to reflect some part of the device's state. </p>

<p>Referenced by <a class="el" href="classSegwayRMP.html#a533bab32d35b2733f40e9083d0df0531">SegwayRMP::Main()</a>, <a class="el" href="classRFLEX.html#a521224f2064ccf8a4c8b3529af3dc807">RFLEX::Main()</a>, <a class="el" href="classREB.html#ab8d0630b1443e0741798613fb2bd4dc0">REB::Main()</a>, <a class="el" href="classER.html#af2d9f11435db5bf7851fdc2a2295f00e">ER::Main()</a>, <a class="el" href="classClodBuster.html#a17e7205d0e32302d52aa4dc1ef0d6c5e">ClodBuster::Main()</a>, <a class="el" href="classCameraUvc.html#aa36dfa343b6711548bcc0a09565c4bb6">CameraUvc::Main()</a>, <a class="el" href="classSegwayRMP400.html#af9a7d2442e7dbd619197c7219afd3b26">SegwayRMP400::ProcessData()</a>, <a class="el" href="classsnd.html#a92897857622d982630d9d93104fd3b42">snd::ProcessMessage()</a>, <a class="el" href="classSegwayRMP400.html#a349a66282dd9c799c541014713d2cec4">SegwayRMP400::ProcessMessage()</a>, <a class="el" href="classLaserTransform.html#ad85a020e370ec75e3977bed61a0624f7">LaserTransform::ProcessMessage()</a>, <a class="el" href="classImageBase.html#ae5a2a84cbe890dd5b257b2c7bb43d250">ImageBase::ProcessMessage()</a>, and <a class="el" href="classGarciaDriver.html#af0f620f101f28c478f3623d308247adf">GarciaDriver::ProcessMessage()</a>.</p>

</div>
</div>
<a class="anchor" id="ga59ed953188471436df98bfc3adf0f457"></a><!-- doxytag: member="player.h::PLAYER_MSGTYPE_REQ" ref="ga59ed953188471436df98bfc3adf0f457" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define PLAYER_MSGTYPE_REQ&nbsp;&nbsp;&nbsp;3</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>A request message. </p>
<p>Such messages are published synchronously to devices, usually to get or set some aspect of the device's state that is not available in data or command messages. Every request message gets a response message (either PLAYER_MSGTYPE_RESP_ACK or PLAYER_MSGTYPE_RESP_NACK). </p>

<p>Referenced by <a class="el" href="classwbr914.html#ace8ddb319d524ee9137f150d3e03358b">wbr914::ProcessMessage()</a>, <a class="el" href="classToRanger.html#a2a0a688951f0f51460c259584493e7ea">ToRanger::ProcessMessage()</a>, <a class="el" href="classSphereDriver.html#aa28d5b13e311c66f663c1f68f4b09ce4">SphereDriver::ProcessMessage()</a>, <a class="el" href="classsnd.html#a92897857622d982630d9d93104fd3b42">snd::ProcessMessage()</a>, <a class="el" href="classSegwayRMP400.html#a349a66282dd9c799c541014713d2cec4">SegwayRMP400::ProcessMessage()</a>, <a class="el" href="classSegwayRMP.html#a17e359d0e45f05a98a0891ffab1f2731">SegwayRMP::ProcessMessage()</a>, <a class="el" href="classRFLEX.html#ac7e6af9460ce66489b3cdb094950dbe0">RFLEX::ProcessMessage()</a>, <a class="el" href="classP2OS.html#a91bda6c36ac50b99c6cf4a3f9258cb8c">P2OS::ProcessMessage()</a>, <a class="el" href="classMapTransform.html#a4a4fc2e74cfd93df0c7c08ad2c1dca73">MapTransform::ProcessMessage()</a>, <a class="el" href="classLaserTransform.html#ad85a020e370ec75e3977bed61a0624f7">LaserTransform::ProcessMessage()</a>, <a class="el" href="classKhepera.html#a7677b4bb9f6eb25531b7c418935ba9f1">Khepera::ProcessMessage()</a>, <a class="el" href="classGarciaDriver.html#af0f620f101f28c478f3623d308247adf">GarciaDriver::ProcessMessage()</a>, <a class="el" href="classFromRanger.html#a95869a189fba3c194cad01e92639fa6d">FromRanger::ProcessMessage()</a>, <a class="el" href="classErratic.html#aa5efa738ad74d1bd6e6e053459f395a9">Erratic::ProcessMessage()</a>, <a class="el" href="classER.html#a12a52473e8b394db5147bb9bc0624dea">ER::ProcessMessage()</a>, <a class="el" href="classClodBuster.html#aae4c6405f68dba4402aea3d95e641c4f">ClodBuster::ProcessMessage()</a>, <a class="el" href="classAdaptiveMCL.html#a97cf8c8a874e314c852c73d9ee967df6">AdaptiveMCL::ProcessMessage()</a>, and <a class="el" href="classAlsa.html#a7ed88e541c2471cc7bb1cebda8025e41">Alsa::ProcessMessage()</a>.</p>

</div>
</div>
<a class="anchor" id="ga312e72e1417096125470061385979696"></a><!-- doxytag: member="player.h::PLAYER_MSGTYPE_RESP_ACK" ref="ga312e72e1417096125470061385979696" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define PLAYER_MSGTYPE_RESP_ACK&nbsp;&nbsp;&nbsp;4</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>A positive response message. </p>
<p>Such messages are published in response to a PLAYER_MSGTYPE_REQ. This message indicates that the underlying driver received, interpreted, and processed the request. Any requested data is in the body of this response message. </p>

<p>Referenced by <a class="el" href="classToRanger.html#a2a0a688951f0f51460c259584493e7ea">ToRanger::ProcessMessage()</a>, <a class="el" href="classSphereDriver.html#aa28d5b13e311c66f663c1f68f4b09ce4">SphereDriver::ProcessMessage()</a>, <a class="el" href="classSegwayRMP400.html#a349a66282dd9c799c541014713d2cec4">SegwayRMP400::ProcessMessage()</a>, <a class="el" href="classRFLEX.html#ac7e6af9460ce66489b3cdb094950dbe0">RFLEX::ProcessMessage()</a>, <a class="el" href="classMapTransform.html#a4a4fc2e74cfd93df0c7c08ad2c1dca73">MapTransform::ProcessMessage()</a>, <a class="el" href="classLaserTransform.html#ad85a020e370ec75e3977bed61a0624f7">LaserTransform::ProcessMessage()</a>, <a class="el" href="classKhepera.html#a7677b4bb9f6eb25531b7c418935ba9f1">Khepera::ProcessMessage()</a>, <a class="el" href="classFromRanger.html#a95869a189fba3c194cad01e92639fa6d">FromRanger::ProcessMessage()</a>, <a class="el" href="classER.html#a12a52473e8b394db5147bb9bc0624dea">ER::ProcessMessage()</a>, <a class="el" href="classClodBuster.html#aae4c6405f68dba4402aea3d95e641c4f">ClodBuster::ProcessMessage()</a>, and <a class="el" href="classAdaptiveMCL.html#a97cf8c8a874e314c852c73d9ee967df6">AdaptiveMCL::ProcessMessage()</a>.</p>

</div>
</div>
<a class="anchor" id="gae80fbeee8ef3da0e6f78ec1a18613750"></a><!-- doxytag: member="player.h::PLAYER_MSGTYPE_RESP_NACK" ref="gae80fbeee8ef3da0e6f78ec1a18613750" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define PLAYER_MSGTYPE_RESP_NACK&nbsp;&nbsp;&nbsp;6</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>A negative response message. </p>
<p>Such messages are published in response to a PLAYER_MSGTYPE_REQ. This messages indicates that the underlying driver did not process the message. Possible causes include: the driver's message queue was full, the driver failed to interpret the request, or the the driver does not support the request. This message will have no data in the body. </p>

<p>Referenced by <a class="el" href="classToRanger.html#a2a0a688951f0f51460c259584493e7ea">ToRanger::ProcessMessage()</a>, <a class="el" href="classLaserTransform.html#ad85a020e370ec75e3977bed61a0624f7">LaserTransform::ProcessMessage()</a>, <a class="el" href="classKhepera.html#a7677b4bb9f6eb25531b7c418935ba9f1">Khepera::ProcessMessage()</a>, <a class="el" href="classFromRanger.html#a95869a189fba3c194cad01e92639fa6d">FromRanger::ProcessMessage()</a>, and <a class="el" href="classER.html#a12a52473e8b394db5147bb9bc0624dea">ER::ProcessMessage()</a>.</p>

</div>
</div>
<a class="anchor" id="ga5bf6a8dfdb85327b655811823824f34a"></a><!-- doxytag: member="player.h::PLAYER_MSGTYPE_SYNCH" ref="ga5bf6a8dfdb85327b655811823824f34a" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define PLAYER_MSGTYPE_SYNCH&nbsp;&nbsp;&nbsp;5</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>A synch message. </p>
<p>Only used in <a class="el" href="group__interface__player.html#ga32e47dfa038a268985593fc0bb9cd19b">PLAYER_DATAMODE_PULL</a> mode. Sent at the end of the set of messages that are sent in response to a <a class="el" href="group__interface__player.html#ga0cdf130802a6880322e42e029ec2a384">PLAYER_PLAYER_REQ_DATA</a> request. </p>

</div>
</div>
</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>

Perl :: Catalyst :: PostgreSQL :: RPM Valid HTML 4.01 Transitional