Sophie

Sophie

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

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>error.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"> *  This library is free software; you can redistribute it and/or</span>
<a name="l00007"></a>00007 <span class="comment"> *  modify it under the terms of the GNU Lesser General Public</span>
<a name="l00008"></a>00008 <span class="comment"> *  License as published by the Free Software Foundation; either</span>
<a name="l00009"></a>00009 <span class="comment"> *  version 2.1 of the License, or (at your option) any later version.</span>
<a name="l00010"></a>00010 <span class="comment"> *</span>
<a name="l00011"></a>00011 <span class="comment"> *  This library is distributed in the hope that it will be useful,</span>
<a name="l00012"></a>00012 <span class="comment"> *  but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00013"></a>00013 <span class="comment"> *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU</span>
<a name="l00014"></a>00014 <span class="comment"> *  Lesser General Public License for more details.</span>
<a name="l00015"></a>00015 <span class="comment"> *</span>
<a name="l00016"></a>00016 <span class="comment"> *  You should have received a copy of the GNU Lesser General Public</span>
<a name="l00017"></a>00017 <span class="comment"> *  License along with this library; if not, write to the Free Software</span>
<a name="l00018"></a>00018 <span class="comment"> *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA</span>
<a name="l00019"></a>00019 <span class="comment"> *</span>
<a name="l00020"></a>00020 <span class="comment"> ********************************************************************/</span>
<a name="l00021"></a>00021 
<a name="l00022"></a>00022 <span class="comment">/***************************************************************************</span>
<a name="l00023"></a>00023 <span class="comment"> * Desc: Error handling macros</span>
<a name="l00024"></a>00024 <span class="comment"> * Author: Andrew Howard</span>
<a name="l00025"></a>00025 <span class="comment"> * Date: 13 May 2002</span>
<a name="l00026"></a>00026 <span class="comment"> * CVS: $Id: error.h 8003 2009-07-13 10:34:37Z thjc $</span>
<a name="l00027"></a>00027 <span class="comment"> **************************************************************************/</span>
<a name="l00028"></a>00028 
<a name="l00029"></a>00029 <span class="preprocessor">#ifndef ERROR_HH</span>
<a name="l00030"></a>00030 <span class="preprocessor"></span><span class="preprocessor">#define ERROR_HH</span>
<a name="l00031"></a>00031 <span class="preprocessor"></span>
<a name="l00032"></a>00032 <span class="preprocessor">#include &lt;stdio.h&gt;</span>
<a name="l00033"></a>00033 <span class="preprocessor">#include &lt;errno.h&gt;</span>
<a name="l00034"></a>00034 
<a name="l00035"></a>00035 <span class="preprocessor">#include &lt;playerconfig.h&gt;</span>
<a name="l00036"></a>00036 
<a name="l00037"></a>00037 <span class="preprocessor">#if defined (WIN32)</span>
<a name="l00038"></a>00038 <span class="preprocessor"></span><span class="preprocessor">  #if defined (PLAYER_STATIC)</span>
<a name="l00039"></a>00039 <span class="preprocessor"></span><span class="preprocessor">    #define PLAYERERROR_EXPORT</span>
<a name="l00040"></a>00040 <span class="preprocessor"></span><span class="preprocessor">  #elif defined (playererror_EXPORTS)</span>
<a name="l00041"></a>00041 <span class="preprocessor"></span><span class="preprocessor">    #define PLAYERERROR_EXPORT    __declspec (dllexport)</span>
<a name="l00042"></a>00042 <span class="preprocessor"></span><span class="preprocessor">  #else</span>
<a name="l00043"></a>00043 <span class="preprocessor"></span><span class="preprocessor">    #define PLAYERERROR_EXPORT    __declspec (dllimport)</span>
<a name="l00044"></a>00044 <span class="preprocessor"></span><span class="preprocessor">  #endif</span>
<a name="l00045"></a>00045 <span class="preprocessor"></span><span class="preprocessor">#else</span>
<a name="l00046"></a>00046 <span class="preprocessor"></span><span class="preprocessor">  #define PLAYERERROR_EXPORT</span>
<a name="l00047"></a>00047 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
<a name="l00048"></a>00048 <span class="preprocessor"></span>
<a name="l00049"></a>00049 <span class="preprocessor">#ifdef __cplusplus</span>
<a name="l00050"></a>00050 <span class="preprocessor"></span><span class="keyword">extern</span> <span class="stringliteral">&quot;C&quot;</span> {
<a name="l00051"></a>00051 <span class="preprocessor">#endif</span>
<a name="l00052"></a>00052 <span class="preprocessor"></span>
<a name="l00054"></a>00054 PLAYERERROR_EXPORT <span class="keywordtype">void</span> ErrorInit(<span class="keywordtype">int</span> _msgLevel, FILE * logfile);
<a name="l00055"></a>00055 
<a name="l00058"></a>00058 PLAYERERROR_EXPORT <span class="keywordtype">void</span> DefaultErrorPrint(<span class="keywordtype">int</span> msgType, <span class="keywordtype">int</span> level, <span class="keyword">const</span> <span class="keywordtype">char</span> *file, <span class="keywordtype">int</span> line, <span class="keyword">const</span> <span class="keywordtype">char</span> *fmt, ...);
<a name="l00059"></a>00059 
<a name="l00060"></a>00060 PLAYERERROR_EXPORT <span class="keyword">extern</span> void (*ErrorPrint)(<span class="keywordtype">int</span> msgType, <span class="keywordtype">int</span> level, <span class="keyword">const</span> <span class="keywordtype">char</span> *file, <span class="keywordtype">int</span> line, <span class="keyword">const</span> <span class="keywordtype">char</span> *fmt, ...);
<a name="l00061"></a>00061 PLAYERERROR_EXPORT <span class="keyword">extern</span> <span class="keywordtype">int</span> msgLevel;
<a name="l00062"></a>00062 
<a name="l00063"></a>00063 <span class="comment">// File for logging messages</span>
<a name="l00064"></a>00064 PLAYERERROR_EXPORT <span class="keyword">extern</span> FILE *msgFile;
<a name="l00065"></a>00065 
<a name="l00066"></a>00066 <span class="preprocessor">#ifdef __cplusplus</span>
<a name="l00067"></a>00067 <span class="preprocessor"></span>}
<a name="l00068"></a>00068 <span class="preprocessor">#endif</span>
<a name="l00069"></a>00069 <span class="preprocessor"></span>
<a name="l00070"></a>00070 
<a name="l00072"></a>00072 <span class="preprocessor">#define PLAYER_ERR_ERR 0</span>
<a name="l00073"></a>00073 <span class="preprocessor"></span><span class="preprocessor">#define PLAYER_ERR_WARN 1</span>
<a name="l00074"></a>00074 <span class="preprocessor"></span><span class="preprocessor">#define PLAYER_ERR_MSG 2</span>
<a name="l00075"></a>00075 <span class="preprocessor"></span><span class="preprocessor">#define PLAYER_ERR_DBG 2</span>
<a name="l00076"></a>00076 <span class="preprocessor"></span>
<a name="l00080"></a>00080 
<a name="l00081"></a><a class="code" href="group__libplayercommon.html#ga037512b044a9b748088953b8229daf7e">00081</a> <span class="preprocessor">#define PLAYER_ERROR(msg)         ErrorPrint(PLAYER_ERR_ERR, 0, __FILE__, __LINE__, &quot;error   : &quot; msg &quot;\n&quot;)</span>
<a name="l00082"></a><a class="code" href="group__libplayercommon.html#ga1b2436798c6df244fe23a1354698b430">00082</a> <span class="preprocessor"></span><span class="preprocessor">#define PLAYER_ERROR1(msg, a)     ErrorPrint(PLAYER_ERR_ERR, 0, __FILE__, __LINE__, &quot;error   : &quot; msg &quot;\n&quot;, a)</span>
<a name="l00083"></a><a class="code" href="group__libplayercommon.html#gac9dda8a4806b885d9e37a44f263e7bb6">00083</a> <span class="preprocessor"></span><span class="preprocessor">#define PLAYER_ERROR2(msg, a, b)  ErrorPrint(PLAYER_ERR_ERR, 0, __FILE__, __LINE__, &quot;error   : &quot; msg &quot;\n&quot;, a, b)</span>
<a name="l00084"></a><a class="code" href="group__libplayercommon.html#ga836efa989f22f243a786392145b13e62">00084</a> <span class="preprocessor"></span><span class="preprocessor">#define PLAYER_ERROR3(msg, a, b, c)  ErrorPrint(PLAYER_ERR_ERR, 0, __FILE__, __LINE__,  &quot;error   : &quot; msg &quot;\n&quot;, a, b, c)</span>
<a name="l00085"></a><a class="code" href="group__libplayercommon.html#gadf30b54c1ba4a78c4104c363e6515a67">00085</a> <span class="preprocessor"></span><span class="preprocessor">#define PLAYER_ERROR4(msg, a, b, c,d)  ErrorPrint(PLAYER_ERR_ERR, 0, __FILE__, __LINE__,  &quot;error   : &quot; msg &quot;\n&quot;, a, b, c, d)</span>
<a name="l00086"></a><a class="code" href="group__libplayercommon.html#gaadd58fa3701d3e9aff37a91e55d81114">00086</a> <span class="preprocessor"></span><span class="preprocessor">#define PLAYER_ERROR5(msg, a, b, c, d, e)  ErrorPrint(PLAYER_ERR_ERR, 0, __FILE__, __LINE__,  &quot;error   : &quot; msg &quot;\n&quot;, a, b, c, d, e)</span>
<a name="l00087"></a>00087 <span class="preprocessor"></span>
<a name="l00089"></a><a class="code" href="group__libplayercommon.html#ga107ea47b28d5a6293b328ece093a91db">00089</a> <span class="preprocessor">#define PLAYER_WARN(msg)        ErrorPrint(PLAYER_ERR_WARN, 0, __FILE__, __LINE__, &quot;warning : &quot; msg &quot;\n&quot;)</span>
<a name="l00090"></a><a class="code" href="group__libplayercommon.html#ga65a614d6a5e549ca15019bcc8aa7f931">00090</a> <span class="preprocessor"></span><span class="preprocessor">#define PLAYER_WARN1(msg, a)    ErrorPrint(PLAYER_ERR_WARN, 0, __FILE__, __LINE__, &quot;warning : &quot; msg &quot;\n&quot;, a)</span>
<a name="l00091"></a><a class="code" href="group__libplayercommon.html#ga6f6ae6e397b4da882314f78dc2665d35">00091</a> <span class="preprocessor"></span><span class="preprocessor">#define PLAYER_WARN2(msg, a, b) ErrorPrint(PLAYER_ERR_WARN, 0, __FILE__, __LINE__, &quot;warning : &quot; msg &quot;\n&quot;, a, b)</span>
<a name="l00092"></a><a class="code" href="group__libplayercommon.html#ga69709c72e0a6560841cdf8ee3f5876c2">00092</a> <span class="preprocessor"></span><span class="preprocessor">#define PLAYER_WARN3(msg, a, b, c) ErrorPrint(PLAYER_ERR_WARN, 0, __FILE__, __LINE__, &quot;warning : &quot; msg &quot;\n&quot;, a, b, c)</span>
<a name="l00093"></a><a class="code" href="group__libplayercommon.html#gaff1df23a6aa0120c674958117af23031">00093</a> <span class="preprocessor"></span><span class="preprocessor">#define PLAYER_WARN4(msg, a, b, c, d) ErrorPrint(PLAYER_ERR_WARN, 0, __FILE__, __LINE__, &quot;warning : &quot; msg &quot;\n&quot;, a, b, c, d)</span>
<a name="l00094"></a><a class="code" href="group__libplayercommon.html#gaa9e99d8a3580f39a7eb12db7ae08f0ae">00094</a> <span class="preprocessor"></span><span class="preprocessor">#define PLAYER_WARN5(msg, a, b, c, d, e) ErrorPrint(PLAYER_ERR_WARN, 0, __FILE__, __LINE__, &quot;warning : &quot; msg &quot;\n&quot;, a, b, c, d, e)</span>
<a name="l00095"></a><a class="code" href="group__libplayercommon.html#ga2feb3b413f9733726430313dc1ab7863">00095</a> <span class="preprocessor"></span><span class="preprocessor">#define PLAYER_WARN6(msg, a, b, c, d, e, f) ErrorPrint(PLAYER_ERR_WARN, 0, __FILE__, __LINE__, &quot;warning : &quot; msg &quot;\n&quot;, a, b, c, d, e, f)</span>
<a name="l00096"></a><a class="code" href="group__libplayercommon.html#gac9dd7d1f720f7b9493159eeef5d1a0d5">00096</a> <span class="preprocessor"></span><span class="preprocessor">#define PLAYER_WARN7(msg, a, b, c, d, e, f, g) ErrorPrint(PLAYER_ERR_WARN, 0, __FILE__, __LINE__, &quot;warning : &quot; msg &quot;\n&quot;, a, b, c, d, e, f, g)</span>
<a name="l00097"></a>00097 <span class="preprocessor"></span>
<a name="l00105"></a><a class="code" href="group__libplayercommon.html#gae7553e0b3d58ba01b7ece74c89430cd7">00105</a> <span class="preprocessor">#define PLAYER_MSG0(level, msg) ErrorPrint(PLAYER_ERR_MSG, level, __FILE__, __LINE__, &quot;&quot; msg &quot;\n&quot;) </span>
<a name="l00106"></a><a class="code" href="group__libplayercommon.html#gad379e27a836c950a5d63905a61574d5d">00106</a> <span class="preprocessor"></span><span class="preprocessor">#define PLAYER_MSG1(level, msg, a) ErrorPrint(PLAYER_ERR_MSG, level, __FILE__, __LINE__, &quot;&quot; msg &quot;\n&quot;, a) </span>
<a name="l00107"></a><a class="code" href="group__libplayercommon.html#ga32eb2b754eb9149a8e71408d77d57412">00107</a> <span class="preprocessor"></span><span class="preprocessor">#define PLAYER_MSG2(level, msg, a, b)  ErrorPrint(PLAYER_ERR_MSG, level, __FILE__, __LINE__, &quot;&quot; msg &quot;\n&quot;, a, b)</span>
<a name="l00108"></a><a class="code" href="group__libplayercommon.html#ga8ed5d3c98dbd7e7f32fc980db221eadf">00108</a> <span class="preprocessor"></span><span class="preprocessor">#define PLAYER_MSG3(level, msg, a, b, c) ErrorPrint(PLAYER_ERR_MSG, level, __FILE__, __LINE__, &quot;&quot; msg &quot;\n&quot;, a, b, c)</span>
<a name="l00109"></a><a class="code" href="group__libplayercommon.html#ga05364f423d30c6fe88eec397b6cf0bf5">00109</a> <span class="preprocessor"></span><span class="preprocessor">#define PLAYER_MSG4(level, msg, a, b, c, d) ErrorPrint(PLAYER_ERR_MSG, level, __FILE__, __LINE__, &quot;&quot; msg &quot;\n&quot;, a, b, c, d)</span>
<a name="l00110"></a><a class="code" href="group__libplayercommon.html#gaec456f8eddade3f26a40900b09c75bb3">00110</a> <span class="preprocessor"></span><span class="preprocessor">#define PLAYER_MSG5(level, msg, a, b, c, d, e) ErrorPrint(PLAYER_ERR_MSG, level, __FILE__, __LINE__, &quot;&quot; msg &quot;\n&quot;, a, b, c, d, e)</span>
<a name="l00111"></a><a class="code" href="group__libplayercommon.html#gaaba84a292905524c1a326ad26469a837">00111</a> <span class="preprocessor"></span><span class="preprocessor">#define PLAYER_MSG6(level, msg, a, b, c, d, e, f) ErrorPrint(PLAYER_ERR_MSG, level, __FILE__, __LINE__, &quot;&quot; msg &quot;\n&quot;, a, b, c, d, e, f)</span>
<a name="l00112"></a><a class="code" href="group__libplayercommon.html#gaa1cb106e623d72a93bf1365019d33df9">00112</a> <span class="preprocessor"></span><span class="preprocessor">#define PLAYER_MSG7(level, msg, a, b, c, d, e, f, g) ErrorPrint(PLAYER_ERR_MSG, level, __FILE__, __LINE__, &quot;&quot; msg &quot;\n&quot;, a, b, c, d, e, f, g)</span>
<a name="l00113"></a>00113 <span class="preprocessor"></span>
<a name="l00116"></a>00116 <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>