Sophie

Sophie

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

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="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="#pri-methods">Private Member Functions</a> &#124;
<a href="#pri-attribs">Private Attributes</a>  </div>
  <div class="headertitle">
<h1>erSIP Class Reference</h1>  </div>
</div>
<div class="contents">
<!-- doxytag: class="erSIP" -->
<p><a href="classerSIP-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7e22959b06006b62158c5803ea90842f"></a><!-- doxytag: member="erSIP::Parse" ref="a7e22959b06006b62158c5803ea90842f" args="(unsigned char *buffer, int length)" -->
bool&nbsp;</td><td class="memItemRight" valign="bottom"><b>Parse</b> (unsigned char *buffer, int length)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a03546d5c6606d2e883392f70ddb92dba"></a><!-- doxytag: member="erSIP::Print" ref="a03546d5c6606d2e883392f70ddb92dba" args="()" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><b>Print</b> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7775125c0dc939b1e7b0b5c4d77bcea2"></a><!-- doxytag: member="erSIP::Fill" ref="a7775125c0dc939b1e7b0b5c4d77bcea2" args="(player_erratic_data_t *data)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><b>Fill</b> (player_erratic_data_t *data)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af000bfe11041398bc6eaa7c5122077c7"></a><!-- doxytag: member="erSIP::erSIP" ref="af000bfe11041398bc6eaa7c5122077c7" args="(int idx)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><b>erSIP</b> (int idx)</td></tr>
<tr><td colspan="2"><h2><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aeab38218978dfb95a2f4ba3066108a0d"></a><!-- doxytag: member="erSIP::lwstall" ref="aeab38218978dfb95a2f4ba3066108a0d" args="" -->
bool&nbsp;</td><td class="memItemRight" valign="bottom"><b>lwstall</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa826ef04c250dc19bbe1d62a6b21e1c8"></a><!-- doxytag: member="erSIP::rwstall" ref="aa826ef04c250dc19bbe1d62a6b21e1c8" args="" -->
bool&nbsp;</td><td class="memItemRight" valign="bottom"><b>rwstall</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4daa9bc9b68029e3db4cf4b0dd065d95"></a><!-- doxytag: member="erSIP::status" ref="a4daa9bc9b68029e3db4cf4b0dd065d95" args="" -->
unsigned char&nbsp;</td><td class="memItemRight" valign="bottom"><b>status</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad58015f96dcffc51cd3ad9e192dd45f3"></a><!-- doxytag: member="erSIP::battery" ref="ad58015f96dcffc51cd3ad9e192dd45f3" args="" -->
unsigned char&nbsp;</td><td class="memItemRight" valign="bottom"><b>battery</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3fa7eadfe573daaee8fd9979fdbaad7c"></a><!-- doxytag: member="erSIP::ptu" ref="a3fa7eadfe573daaee8fd9979fdbaad7c" args="" -->
unsigned short&nbsp;</td><td class="memItemRight" valign="bottom"><b>ptu</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8946e6e938a37b7d893e0d064d147e46"></a><!-- doxytag: member="erSIP::timer" ref="a8946e6e938a37b7d893e0d064d147e46" args="" -->
unsigned short&nbsp;</td><td class="memItemRight" valign="bottom"><b>timer</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a451b156231b8b61646a4d0cd802c0d9d"></a><!-- doxytag: member="erSIP::rawxpos" ref="a451b156231b8b61646a4d0cd802c0d9d" args="" -->
unsigned short&nbsp;</td><td class="memItemRight" valign="bottom"><b>rawxpos</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a871f1db0482356ec2acfd59626c07dc9"></a><!-- doxytag: member="erSIP::rawypos" ref="a871f1db0482356ec2acfd59626c07dc9" args="" -->
unsigned short&nbsp;</td><td class="memItemRight" valign="bottom"><b>rawypos</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a31b052dc43a28b3c97a35615b20e60fb"></a><!-- doxytag: member="erSIP::angle" ref="a31b052dc43a28b3c97a35615b20e60fb" args="" -->
short&nbsp;</td><td class="memItemRight" valign="bottom"><b>angle</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8cb23f1a244a04640ab12aa36c9190d5"></a><!-- doxytag: member="erSIP::lvel" ref="a8cb23f1a244a04640ab12aa36c9190d5" args="" -->
short&nbsp;</td><td class="memItemRight" valign="bottom"><b>lvel</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aef7d8d1098525c78392836a2a6df467c"></a><!-- doxytag: member="erSIP::rvel" ref="aef7d8d1098525c78392836a2a6df467c" args="" -->
short&nbsp;</td><td class="memItemRight" valign="bottom"><b>rvel</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a59d75d80d2fedc225b87dee0dbeddc41"></a><!-- doxytag: member="erSIP::control" ref="a59d75d80d2fedc225b87dee0dbeddc41" args="" -->
short&nbsp;</td><td class="memItemRight" valign="bottom"><b>control</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afb110ee2788eebb74b6abd2a7a36a61e"></a><!-- doxytag: member="erSIP::xpos" ref="afb110ee2788eebb74b6abd2a7a36a61e" args="" -->
int&nbsp;</td><td class="memItemRight" valign="bottom"><b>xpos</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aeae08e1650b77fad195687c4b7ec888d"></a><!-- doxytag: member="erSIP::ypos" ref="aeae08e1650b77fad195687c4b7ec888d" args="" -->
int&nbsp;</td><td class="memItemRight" valign="bottom"><b>ypos</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a241ed4a12f53ea2adb9b01e5c186f1c9"></a><!-- doxytag: member="erSIP::x_offset" ref="a241ed4a12f53ea2adb9b01e5c186f1c9" args="" -->
int&nbsp;</td><td class="memItemRight" valign="bottom"><b>x_offset</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a79492c8004e66ee08146dc2dd9727b95"></a><!-- doxytag: member="erSIP::y_offset" ref="a79492c8004e66ee08146dc2dd9727b95" args="" -->
int&nbsp;</td><td class="memItemRight" valign="bottom"><b>y_offset</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1d1c9a8bb654d17452708dc646160b70"></a><!-- doxytag: member="erSIP::angle_offset" ref="a1d1c9a8bb654d17452708dc646160b70" args="" -->
int&nbsp;</td><td class="memItemRight" valign="bottom"><b>angle_offset</b></td></tr>
<tr><td colspan="2"><h2><a name="pri-methods"></a>
Private Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aaeddfdddc232898059999010df51e179"></a><!-- doxytag: member="erSIP::PositionChange" ref="aaeddfdddc232898059999010df51e179" args="(unsigned short, unsigned short)" -->
int&nbsp;</td><td class="memItemRight" valign="bottom"><b>PositionChange</b> (unsigned short, unsigned short)</td></tr>
<tr><td colspan="2"><h2><a name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6bb48dbf78bdffad583149a42b1b5f4b"></a><!-- doxytag: member="erSIP::param_idx" ref="a6bb48dbf78bdffad583149a42b1b5f4b" args="" -->
int&nbsp;</td><td class="memItemRight" valign="bottom"><b>param_idx</b></td></tr>
</table>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="erratic_2sip_8h_source.html">erratic/sip.h</a></li>
<li>erratic/sip.cc</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>