Sophie

Sophie

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

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="navpath">
    <ul>
      <li><b>PlayerCc</b>      </li>
      <li><a class="el" href="classPlayerCc_1_1SimulationProxy.html">PlayerCc::SimulationProxy</a>      </li>
    </ul>
  </div>
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pri-methods">Private Member Functions</a> &#124;
<a href="#pri-attribs">Private Attributes</a>  </div>
  <div class="headertitle">
<h1>PlayerCc::SimulationProxy Class Reference<br/>
<small>
[<a class="el" href="group__player__clientlib__cplusplus__proxies.html">Proxies</a>]</small>
</h1>  </div>
</div>
<div class="contents">
<!-- doxytag: class="PlayerCc::SimulationProxy" --><!-- doxytag: inherits="PlayerCc::ClientProxy" -->
<p>The <code><a class="el" href="classPlayerCc_1_1SimulationProxy.html" title="The SimulationProxy proxy provides access to a simulation device.">SimulationProxy</a></code> proxy provides access to a <a class="el" href="group__interface__simulation.html">simulation</a> device.  
<a href="#_details">More...</a></p>

<p><code>#include &lt;<a class="el" href="playerc_09_09_8h_source.html">playerc++.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for PlayerCc::SimulationProxy:</div>
<div class="dyncontent">
 <div class="center">
  <img src="classPlayerCc_1_1SimulationProxy.png" usemap="#PlayerCc::SimulationProxy_map" alt=""/>
  <map id="PlayerCc::SimulationProxy_map" name="PlayerCc::SimulationProxy_map">
<area href="classPlayerCc_1_1ClientProxy.html" alt="PlayerCc::ClientProxy" shape="rect" coords="0,0,161,24"/>
</map>
</div>

<p><a href="classPlayerCc_1_1SimulationProxy-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="a3c38398ca6d4b6c89baff7c0b0a3b9e1"></a><!-- doxytag: member="PlayerCc::SimulationProxy::SimulationProxy" ref="a3c38398ca6d4b6c89baff7c0b0a3b9e1" args="(PlayerClient *aPc, uint32_t aIndex=0)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPlayerCc_1_1SimulationProxy.html#a3c38398ca6d4b6c89baff7c0b0a3b9e1">SimulationProxy</a> (<a class="el" href="classPlayerCc_1_1PlayerClient.html">PlayerClient</a> *aPc, uint32_t aIndex=0)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">constructor <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a73a583ed0ba2039c084c4934511f68bd"></a><!-- doxytag: member="PlayerCc::SimulationProxy::~SimulationProxy" ref="a73a583ed0ba2039c084c4934511f68bd" args="()" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPlayerCc_1_1SimulationProxy.html#a73a583ed0ba2039c084c4934511f68bd">~SimulationProxy</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">destructor <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPlayerCc_1_1SimulationProxy.html#a654a959185fcb1c338354285445a288a">SetPose2d</a> (char *identifier, double x, double y, double a)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">set the 2D pose of an object in the simulator, identified by the std::string.  <a href="#a654a959185fcb1c338354285445a288a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPlayerCc_1_1SimulationProxy.html#a4078d77a8cf58c558d67e624fad8afbc">GetPose2d</a> (char *identifier, double &amp;x, double &amp;y, double &amp;a)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">get the pose of an object in the simulator, identified by the std::string Returns 0 on success, else a non-zero error code.  <a href="#a4078d77a8cf58c558d67e624fad8afbc"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPlayerCc_1_1SimulationProxy.html#a50515d3d67095a08a2780adab61d2223">SetPose3d</a> (char *identifier, double x, double y, double z, double roll, double pitch, double yaw)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">set the 3D pose of an object in the simulator, identified by the std::string.  <a href="#a50515d3d67095a08a2780adab61d2223"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPlayerCc_1_1SimulationProxy.html#a545f19bca96b132d161c33fb7131c415">GetPose3d</a> (char *identifier, double &amp;x, double &amp;y, double &amp;z, double &amp;roll, double &amp;pitch, double &amp;yaw, double &amp;time)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">get the 3D pose of an object in the simulator, identified by the std::string Returns 0 on success, else a non-zero error code.  <a href="#a545f19bca96b132d161c33fb7131c415"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5984a5e23f847fe0c6bc9ffbc55baae7"></a><!-- doxytag: member="PlayerCc::SimulationProxy::GetProperty" ref="a5984a5e23f847fe0c6bc9ffbc55baae7" args="(char *identifier, char *name, void *value, size_t value_len)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPlayerCc_1_1SimulationProxy.html#a5984a5e23f847fe0c6bc9ffbc55baae7">GetProperty</a> (char *identifier, char *name, void *value, size_t value_len)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get a simulation property. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac9f485b013422e0a4d4cb6a9de1a0d4a"></a><!-- doxytag: member="PlayerCc::SimulationProxy::SetProperty" ref="ac9f485b013422e0a4d4cb6a9de1a0d4a" args="(char *identifier, char *name, void *value, size_t value_len)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPlayerCc_1_1SimulationProxy.html#ac9f485b013422e0a4d4cb6a9de1a0d4a">SetProperty</a> (char *identifier, char *name, void *value, size_t value_len)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set a simulation property. <br/></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="a0a602c07c09e2998ac999ca7618678cd"></a><!-- doxytag: member="PlayerCc::SimulationProxy::Subscribe" ref="a0a602c07c09e2998ac999ca7618678cd" args="(uint32_t aIndex)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><b>Subscribe</b> (uint32_t aIndex)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a02c7dedf10b2f2a887c691ac31322f3a"></a><!-- doxytag: member="PlayerCc::SimulationProxy::Unsubscribe" ref="a02c7dedf10b2f2a887c691ac31322f3a" args="()" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><b>Unsubscribe</b> ()</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="a953c93723d3867f99d4dd8bf9d7d887e"></a><!-- doxytag: member="PlayerCc::SimulationProxy::mDevice" ref="a953c93723d3867f99d4dd8bf9d7d887e" args="" -->
<a class="el" href="structplayerc__simulation__t.html">playerc_simulation_t</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><b>mDevice</b></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>The <code><a class="el" href="classPlayerCc_1_1SimulationProxy.html" title="The SimulationProxy proxy provides access to a simulation device.">SimulationProxy</a></code> proxy provides access to a <a class="el" href="group__interface__simulation.html">simulation</a> device. </p>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a4078d77a8cf58c558d67e624fad8afbc"></a><!-- doxytag: member="PlayerCc::SimulationProxy::GetPose2d" ref="a4078d77a8cf58c558d67e624fad8afbc" args="(char *identifier, double &amp;x, double &amp;y, double &amp;a)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void PlayerCc::SimulationProxy::GetPose2d </td>
          <td>(</td>
          <td class="paramtype">char *&nbsp;</td>
          <td class="paramname"> <em>identifier</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">double &amp;&nbsp;</td>
          <td class="paramname"> <em>x</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">double &amp;&nbsp;</td>
          <td class="paramname"> <em>y</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">double &amp;&nbsp;</td>
          <td class="paramname"> <em>a</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>get the pose of an object in the simulator, identified by the std::string Returns 0 on success, else a non-zero error code. </p>

</div>
</div>
<a class="anchor" id="a545f19bca96b132d161c33fb7131c415"></a><!-- doxytag: member="PlayerCc::SimulationProxy::GetPose3d" ref="a545f19bca96b132d161c33fb7131c415" args="(char *identifier, double &amp;x, double &amp;y, double &amp;z, double &amp;roll, double &amp;pitch, double &amp;yaw, double &amp;time)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void PlayerCc::SimulationProxy::GetPose3d </td>
          <td>(</td>
          <td class="paramtype">char *&nbsp;</td>
          <td class="paramname"> <em>identifier</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">double &amp;&nbsp;</td>
          <td class="paramname"> <em>x</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">double &amp;&nbsp;</td>
          <td class="paramname"> <em>y</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">double &amp;&nbsp;</td>
          <td class="paramname"> <em>z</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">double &amp;&nbsp;</td>
          <td class="paramname"> <em>roll</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">double &amp;&nbsp;</td>
          <td class="paramname"> <em>pitch</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">double &amp;&nbsp;</td>
          <td class="paramname"> <em>yaw</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">double &amp;&nbsp;</td>
          <td class="paramname"> <em>time</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>get the 3D pose of an object in the simulator, identified by the std::string Returns 0 on success, else a non-zero error code. </p>

</div>
</div>
<a class="anchor" id="a654a959185fcb1c338354285445a288a"></a><!-- doxytag: member="PlayerCc::SimulationProxy::SetPose2d" ref="a654a959185fcb1c338354285445a288a" args="(char *identifier, double x, double y, double a)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void PlayerCc::SimulationProxy::SetPose2d </td>
          <td>(</td>
          <td class="paramtype">char *&nbsp;</td>
          <td class="paramname"> <em>identifier</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">double&nbsp;</td>
          <td class="paramname"> <em>x</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">double&nbsp;</td>
          <td class="paramname"> <em>y</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">double&nbsp;</td>
          <td class="paramname"> <em>a</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>set the 2D pose of an object in the simulator, identified by the std::string. </p>
<p>Returns 0 on success, else a non-zero error code. </p>

</div>
</div>
<a class="anchor" id="a50515d3d67095a08a2780adab61d2223"></a><!-- doxytag: member="PlayerCc::SimulationProxy::SetPose3d" ref="a50515d3d67095a08a2780adab61d2223" args="(char *identifier, double x, double y, double z, double roll, double pitch, double yaw)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void PlayerCc::SimulationProxy::SetPose3d </td>
          <td>(</td>
          <td class="paramtype">char *&nbsp;</td>
          <td class="paramname"> <em>identifier</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">double&nbsp;</td>
          <td class="paramname"> <em>x</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">double&nbsp;</td>
          <td class="paramname"> <em>y</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">double&nbsp;</td>
          <td class="paramname"> <em>z</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">double&nbsp;</td>
          <td class="paramname"> <em>roll</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">double&nbsp;</td>
          <td class="paramname"> <em>pitch</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">double&nbsp;</td>
          <td class="paramname"> <em>yaw</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>set the 3D pose of an object in the simulator, identified by the std::string. </p>
<p>Returns 0 on success, else a non-zero error code. </p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="playerc_09_09_8h_source.html">playerc++.h</a></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>

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