Sophie: player-doc-3.0.2-5.fc14 noarch

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>interface_util.h</h1>  </div>
</div>
<div class="contents">
<div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span>
<a name="l00002"></a>00002 <span class="comment"> *  Player - One Hell of a Robot Server</span>
<a name="l00003"></a>00003 <span class="comment"> *  Copyright (C) 2000</span>
<a name="l00004"></a>00004 <span class="comment"> *     Brian Gerkey, Kasper Stoy, Richard Vaughan, &amp; Andrew Howard</span>
<a name="l00005"></a>00005 <span class="comment"> *</span>
<a name="l00006"></a>00006 <span class="comment"> *</span>
<a name="l00007"></a>00007 <span class="comment"> *  This program is free software; you can redistribute it and/or modify</span>
<a name="l00008"></a>00008 <span class="comment"> *  it under the terms of the GNU General Public License as published by</span>
<a name="l00009"></a>00009 <span class="comment"> *  the Free Software Foundation; either version 2 of the License, or</span>
<a name="l00010"></a>00010 <span class="comment"> *  (at your option) any later version.</span>
<a name="l00011"></a>00011 <span class="comment"> *</span>
<a name="l00012"></a>00012 <span class="comment"> *  This program is distributed in the hope that it will be useful,</span>
<a name="l00013"></a>00013 <span class="comment"> *  but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00014"></a>00014 <span class="comment"> *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the</span>
<a name="l00015"></a>00015 <span class="comment"> *  GNU General Public License for more details.</span>
<a name="l00016"></a>00016 <span class="comment"> *</span>
<a name="l00017"></a>00017 <span class="comment"> *  You should have received a copy of the GNU General Public License</span>
<a name="l00018"></a>00018 <span class="comment"> *  along with this program; if not, write to the Free Software</span>
<a name="l00019"></a>00019 <span class="comment"> *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA</span>
<a name="l00020"></a>00020 <span class="comment"> *</span>
<a name="l00021"></a>00021 <span class="comment"> */</span>
<a name="l00022"></a>00022 <span class="comment">/********************************************************************</span>
<a name="l00023"></a>00023 <span class="comment"> *</span>
<a name="l00024"></a>00024 <span class="comment"> *  This library is free software; you can redistribute it and/or</span>
<a name="l00025"></a>00025 <span class="comment"> *  modify it under the terms of the GNU Lesser General Public</span>
<a name="l00026"></a>00026 <span class="comment"> *  License as published by the Free Software Foundation; either</span>
<a name="l00027"></a>00027 <span class="comment"> *  version 2.1 of the License, or (at your option) any later version.</span>
<a name="l00028"></a>00028 <span class="comment"> *</span>
<a name="l00029"></a>00029 <span class="comment"> *  This library is distributed in the hope that it will be useful,</span>
<a name="l00030"></a>00030 <span class="comment"> *  but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00031"></a>00031 <span class="comment"> *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU</span>
<a name="l00032"></a>00032 <span class="comment"> *  Lesser General Public License for more details.</span>
<a name="l00033"></a>00033 <span class="comment"> *</span>
<a name="l00034"></a>00034 <span class="comment"> *  You should have received a copy of the GNU Lesser General Public</span>
<a name="l00035"></a>00035 <span class="comment"> *  License along with this library; if not, write to the Free Software</span>
<a name="l00036"></a>00036 <span class="comment"> *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA</span>
<a name="l00037"></a>00037 <span class="comment"> *</span>
<a name="l00038"></a>00038 <span class="comment"> ********************************************************************/</span>
<a name="l00039"></a>00039 
<a name="l00043"></a>00043 <span class="preprocessor">#ifndef _INTERFACE_UTIL_H</span>
<a name="l00044"></a>00044 <span class="preprocessor"></span><span class="preprocessor">#define _INTERFACE_UTIL_H</span>
<a name="l00045"></a>00045 <span class="preprocessor"></span>
<a name="l00046"></a>00046 <span class="preprocessor">#if defined (WIN32)</span>
<a name="l00047"></a>00047 <span class="preprocessor"></span><span class="preprocessor">  #if defined (PLAYER_STATIC)</span>
<a name="l00048"></a>00048 <span class="preprocessor"></span><span class="preprocessor">    #define PLAYERINTERFACE_EXPORT</span>
<a name="l00049"></a>00049 <span class="preprocessor"></span><span class="preprocessor">  #elif defined (playerinterface_EXPORTS)</span>
<a name="l00050"></a>00050 <span class="preprocessor"></span><span class="preprocessor">    #define PLAYERINTERFACE_EXPORT    __declspec (dllexport)</span>
<a name="l00051"></a>00051 <span class="preprocessor"></span><span class="preprocessor">  #else</span>
<a name="l00052"></a>00052 <span class="preprocessor"></span><span class="preprocessor">    #define PLAYERINTERFACE_EXPORT    __declspec (dllimport)</span>
<a name="l00053"></a>00053 <span class="preprocessor"></span><span class="preprocessor">  #endif</span>
<a name="l00054"></a>00054 <span class="preprocessor"></span><span class="preprocessor">#else</span>
<a name="l00055"></a>00055 <span class="preprocessor"></span><span class="preprocessor">  #define PLAYERINTERFACE_EXPORT</span>
<a name="l00056"></a>00056 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
<a name="l00057"></a>00057 <span class="preprocessor"></span>
<a name="l00058"></a>00058 <span class="preprocessor">#include &lt;playerconfig.h&gt;</span>  <span class="comment">// for uint16_t type</span>
<a name="l00059"></a>00059 
<a name="l00060"></a>00060 <span class="preprocessor">#ifdef __cplusplus</span>
<a name="l00061"></a>00061 <span class="preprocessor"></span><span class="keyword">extern</span> <span class="stringliteral">&quot;C&quot;</span> {
<a name="l00062"></a>00062 <span class="preprocessor">#endif</span>
<a name="l00063"></a>00063 <span class="preprocessor"></span>
<a name="l00064"></a>00064 <span class="comment">// available interfaces are stored in an array of these, defined in</span>
<a name="l00065"></a>00065 <span class="comment">// interface_util.c</span>
<a name="l00066"></a><a class="code" href="structplayer__interface__t.html">00066</a> <span class="keyword">typedef</span> <span class="keyword">struct</span>
<a name="l00067"></a>00067 {
<a name="l00068"></a>00068   uint16_t interf;
<a name="l00069"></a>00069   <span class="keywordtype">char</span>* name;
<a name="l00070"></a>00070 } <a class="code" href="structplayer__interface__t.html">player_interface_t</a>;
<a name="l00071"></a>00071 
<a name="l00072"></a>00072 <span class="comment">/*</span>
<a name="l00073"></a>00073 <span class="comment"> * Initialises the interface names/codes table.</span>
<a name="l00074"></a>00074 <span class="comment"> */</span>
<a name="l00075"></a>00075 PLAYERINTERFACE_EXPORT <span class="keywordtype">int</span> itable_init (<span class="keywordtype">void</span>);
<a name="l00076"></a>00076 
<a name="l00077"></a>00077 <span class="comment">/*</span>
<a name="l00078"></a>00078 <span class="comment"> * Grows the interface table to newSize, filling each interface between the</span>
<a name="l00079"></a>00079 <span class="comment"> * old end and the new end with (0xFFFF, &quot;nointerfXX&quot;).</span>
<a name="l00080"></a>00080 <span class="comment"> */</span>
<a name="l00081"></a>00081 PLAYERINTERFACE_EXPORT <span class="keywordtype">int</span> itable_grow (<span class="keywordtype">int</span> newSize);
<a name="l00082"></a>00082 
<a name="l00083"></a>00083 <span class="comment">/*</span>
<a name="l00084"></a>00084 <span class="comment"> * Destroys the interface names/codes table.</span>
<a name="l00085"></a>00085 <span class="comment"> */</span>
<a name="l00086"></a>00086 PLAYERINTERFACE_EXPORT <span class="keywordtype">void</span> itable_destroy (<span class="keywordtype">void</span>);
<a name="l00087"></a>00087 
<a name="l00088"></a>00088 <span class="comment">/*</span>
<a name="l00089"></a>00089 <span class="comment"> * Add a new interface to the interface table.</span>
<a name="l00090"></a>00090 <span class="comment"> */</span>
<a name="l00091"></a>00091 PLAYERINTERFACE_EXPORT <span class="keywordtype">int</span> itable_add (<span class="keyword">const</span> <span class="keywordtype">char</span> *name, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> code, <span class="keywordtype">int</span> replace);
<a name="l00092"></a>00092 
<a name="l00093"></a>00093 <span class="comment">/*</span>
<a name="l00094"></a>00094 <span class="comment"> * looks through the array of available interfaces for one which the given</span>
<a name="l00095"></a>00095 <span class="comment"> * name.  if found, interface is filled out (the caller must provide storage)</span>
<a name="l00096"></a>00096 <span class="comment"> * and zero is returned.  otherwise, -1 is returned.</span>
<a name="l00097"></a>00097 <span class="comment"> */</span>
<a name="l00098"></a>00098 PLAYERINTERFACE_EXPORT <span class="keywordtype">int</span> lookup_interface(<span class="keyword">const</span> <span class="keywordtype">char</span>* name, <a class="code" href="structplayer__interface__t.html">player_interface_t</a>* interf);
<a name="l00099"></a>00099 
<a name="l00100"></a>00100 <span class="comment">/*</span>
<a name="l00101"></a>00101 <span class="comment"> * looks through the array of available interfaces for one which the given</span>
<a name="l00102"></a>00102 <span class="comment"> * code.  if found, interface is filled out (the caller must provide storage)</span>
<a name="l00103"></a>00103 <span class="comment"> * and zero is returned.  otherwise, -1 is returned.</span>
<a name="l00104"></a>00104 <span class="comment"> */</span>
<a name="l00105"></a>00105 PLAYERINTERFACE_EXPORT <span class="keywordtype">int</span>
<a name="l00106"></a>00106 lookup_interface_code(<span class="keywordtype">int</span> code, <a class="code" href="structplayer__interface__t.html">player_interface_t</a>* interf);
<a name="l00107"></a>00107 
<a name="l00108"></a>00108 <span class="comment">/*</span>
<a name="l00109"></a>00109 <span class="comment"> * looks through the array of interfaces, starting at startpos, for the first</span>
<a name="l00110"></a>00110 <span class="comment"> * entry that has the given code, and returns the name.</span>
<a name="l00111"></a>00111 <span class="comment"> * returns 0 if the device is not found.</span>
<a name="l00112"></a>00112 <span class="comment"> */</span>
<a name="l00113"></a>00113 PLAYERINTERFACE_EXPORT <span class="keyword">const</span> <span class="keywordtype">char</span>*
<a name="l00114"></a>00114 lookup_interface_name(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> startpos, <span class="keywordtype">int</span> code);
<a name="l00115"></a>00115 
<a name="l00116"></a>00116 <span class="comment">/*</span>
<a name="l00117"></a>00117 <span class="comment"> * Returns the name of an interface given its code. The result string must</span>
<a name="l00118"></a>00118 <span class="comment"> * not be altered.</span>
<a name="l00119"></a>00119 <span class="comment"> */</span>
<a name="l00120"></a>00120 PLAYERINTERFACE_EXPORT <span class="keyword">const</span> <span class="keywordtype">char</span>*
<a name="l00121"></a>00121 interf_to_str(uint16_t code);
<a name="l00122"></a>00122 
<a name="l00123"></a>00123 <span class="comment">/*</span>
<a name="l00124"></a>00124 <span class="comment"> * Returns the code for an interface, given a string. If the name is not found,</span>
<a name="l00125"></a>00125 <span class="comment"> * 0xFFFF is returned.</span>
<a name="l00126"></a>00126 <span class="comment"> */</span>
<a name="l00127"></a>00127 PLAYERINTERFACE_EXPORT uint16_t
<a name="l00128"></a>00128 str_to_interf(<span class="keyword">const</span> <span class="keywordtype">char</span> *name);
<a name="l00129"></a>00129 
<a name="l00130"></a>00130 <span class="comment">/*</span>
<a name="l00131"></a>00131 <span class="comment"> * Returns the name of a message type given its code. The result string must</span>
<a name="l00132"></a>00132 <span class="comment"> * not be altered.</span>
<a name="l00133"></a>00133 <span class="comment"> */</span>
<a name="l00134"></a>00134 PLAYERINTERFACE_EXPORT <span class="keyword">const</span> <span class="keywordtype">char</span>*
<a name="l00135"></a>00135 msgtype_to_str(uint8_t code);
<a name="l00136"></a>00136 
<a name="l00137"></a>00137 <span class="comment">/*</span>
<a name="l00138"></a>00138 <span class="comment"> * Returns the code for a message type, given a string. If the name is not</span>
<a name="l00139"></a>00139 <span class="comment"> * found, 0xFF is returned.</span>
<a name="l00140"></a>00140 <span class="comment"> */</span>
<a name="l00141"></a>00141 PLAYERINTERFACE_EXPORT uint8_t
<a name="l00142"></a>00142 str_to_msgtype(<span class="keyword">const</span> <span class="keywordtype">char</span> *name);
<a name="l00143"></a>00143 
<a name="l00144"></a>00144 <span class="preprocessor">#ifdef __cplusplus</span>
<a name="l00145"></a>00145 <span class="preprocessor"></span>}
<a name="l00146"></a>00146 <span class="preprocessor">#endif</span>
<a name="l00147"></a>00147 <span class="preprocessor"></span>
<a name="l00150"></a>00150 <span class="preprocessor">#endif</span>
</pre></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>