<!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 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 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="summary"> <a href="#func-members">Functions</a> | <a href="#var-members">Variables</a> </div> <div class="headertitle"> <h1>Constants and utility functions<br/> <small> [<a class="el" href="group__player__clientlib__cplusplus.html">libplayerc++</a>]</small> </h1> </div> </div> <div class="contents"> <p>Helper functions when using the library. <a href="#_details">More...</a></p> <table class="memberdecls"> <tr><td colspan="2"><h2><a name="func-members"></a> Functions</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gaffc4389fb969fc2e431ac70855280892"></a><!-- doxytag: member="player_clientlib_utility::rtod" ref="gaffc4389fb969fc2e431ac70855280892" args="(double r)" --> double </td><td class="memItemRight" valign="bottom"><a class="el" href="group__player__clientlib__utility.html#gaffc4389fb969fc2e431ac70855280892">PlayerCc::rtod</a> (double r)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Convert radians to degrees. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga7a56c56e7c12a45bfab1b86df9edfdc1"></a><!-- doxytag: member="player_clientlib_utility::dtor" ref="ga7a56c56e7c12a45bfab1b86df9edfdc1" args="(double r)" --> double </td><td class="memItemRight" valign="bottom"><a class="el" href="group__player__clientlib__utility.html#ga7a56c56e7c12a45bfab1b86df9edfdc1">PlayerCc::dtor</a> (double r)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Convert degrees to radians. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga89871f427ac094898c036b3d5a98480a"></a><!-- doxytag: member="player_clientlib_utility::normalize" ref="ga89871f427ac094898c036b3d5a98480a" args="(double z)" --> double </td><td class="memItemRight" valign="bottom"><a class="el" href="group__player__clientlib__utility.html#ga89871f427ac094898c036b3d5a98480a">PlayerCc::normalize</a> (double z)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Normalize angle to domain -pi, pi. <br/></td></tr> <tr><td class="memTemplParams" colspan="2"><a class="anchor" id="gae595027e3eb7a9c12bf49dee42d6ea06"></a><!-- doxytag: member="player_clientlib_utility::min" ref="gae595027e3eb7a9c12bf49dee42d6ea06" args="(T a, T b)" --> template<typename T > </td></tr> <tr><td class="memTemplItemLeft" align="right" valign="top">T </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group__player__clientlib__utility.html#gae595027e3eb7a9c12bf49dee42d6ea06">PlayerCc::min</a> (T a, T b)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Return the minimum of a, b. <br/></td></tr> <tr><td class="memTemplParams" colspan="2"><a class="anchor" id="gaa6c2b569d3d0e6c174a49e8ec1aac796"></a><!-- doxytag: member="player_clientlib_utility::max" ref="gaa6c2b569d3d0e6c174a49e8ec1aac796" args="(T a, T b)" --> template<typename T > </td></tr> <tr><td class="memTemplItemLeft" align="right" valign="top">T </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group__player__clientlib__utility.html#gaa6c2b569d3d0e6c174a49e8ec1aac796">PlayerCc::max</a> (T a, T b)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Return the maximum of a, b. <br/></td></tr> <tr><td class="memTemplParams" colspan="2"><a class="anchor" id="ga902d23bb9582b278d85e10477126a10a"></a><!-- doxytag: member="player_clientlib_utility::limit" ref="ga902d23bb9582b278d85e10477126a10a" args="(T a, T min, T max)" --> template<typename T > </td></tr> <tr><td class="memTemplItemLeft" align="right" valign="top">T </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group__player__clientlib__utility.html#ga902d23bb9582b278d85e10477126a10a">PlayerCc::limit</a> (T a, T min, T max)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Limit a value to the range of min, max. <br/></td></tr> <tr><td colspan="2"><h2><a name="var-members"></a> Variables</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga6f4cc8d7ad32a50feb9c285cbe795df7"></a><!-- doxytag: member="player_clientlib_utility::PLAYER_PORTNUM" ref="ga6f4cc8d7ad32a50feb9c285cbe795df7" args="" --> const int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__player__clientlib__utility.html#ga6f4cc8d7ad32a50feb9c285cbe795df7">PlayerCc::PLAYER_PORTNUM</a> = 6665</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">The default port number for <a class="el" href="classPlayerCc_1_1PlayerClient.html" title="The PlayerClient is used for communicating with the player server.">PlayerClient</a>. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga877a8a285e27eba8490bdd5861e4d288"></a><!-- doxytag: member="player_clientlib_utility::PLAYER_HOSTNAME" ref="ga877a8a285e27eba8490bdd5861e4d288" args="" --> const std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="group__player__clientlib__utility.html#ga877a8a285e27eba8490bdd5861e4d288">PlayerCc::PLAYER_HOSTNAME</a> = "localhost"</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">The default hostname for <a class="el" href="classPlayerCc_1_1PlayerClient.html" title="The PlayerClient is used for communicating with the player server.">PlayerClient</a>. <br/></td></tr> </table> <hr/><a name="_details"></a><h2>Detailed Description</h2> <p>Helper functions when using the library. </p> </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>