Sophie

Sophie

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

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_1FiducialProxy.html">PlayerCc::FiducialProxy</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::FiducialProxy 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::FiducialProxy" --><!-- doxytag: inherits="PlayerCc::ClientProxy" -->
<p>The <code><a class="el" href="classPlayerCc_1_1FiducialProxy.html" title="The FiducialProxy class is used to control fiducial devices.">FiducialProxy</a></code> class is used to control <a class="el" href="group__interface__fiducial.html">fiducial</a> devices.  
<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::FiducialProxy:</div>
<div class="dyncontent">
 <div class="center">
  <img src="classPlayerCc_1_1FiducialProxy.png" usemap="#PlayerCc::FiducialProxy_map" alt=""/>
  <map id="PlayerCc::FiducialProxy_map" name="PlayerCc::FiducialProxy_map">
<area href="classPlayerCc_1_1ClientProxy.html" alt="PlayerCc::ClientProxy" shape="rect" coords="0,0,149,24"/>
</map>
</div>

<p><a href="classPlayerCc_1_1FiducialProxy-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="a77b68d1eea61b1b9397f899abf982989"></a><!-- doxytag: member="PlayerCc::FiducialProxy::FiducialProxy" ref="a77b68d1eea61b1b9397f899abf982989" args="(PlayerClient *aPc, uint32_t aIndex=0)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPlayerCc_1_1FiducialProxy.html#a77b68d1eea61b1b9397f899abf982989">FiducialProxy</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="af473f1cb72ac5b37f53a4551aa863afa"></a><!-- doxytag: member="PlayerCc::FiducialProxy::~FiducialProxy" ref="af473f1cb72ac5b37f53a4551aa863afa" args="()" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPlayerCc_1_1FiducialProxy.html#af473f1cb72ac5b37f53a4551aa863afa">~FiducialProxy</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">destructor <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4cce1845f6e3253cb438b7a8b83b83a0"></a><!-- doxytag: member="PlayerCc::FiducialProxy::GetCount" ref="a4cce1845f6e3253cb438b7a8b83b83a0" args="() const " -->
uint32_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPlayerCc_1_1FiducialProxy.html#a4cce1845f6e3253cb438b7a8b83b83a0">GetCount</a> () const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The number of beacons detected. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a557bb686a0554ceef9534f06dd939196"></a><!-- doxytag: member="PlayerCc::FiducialProxy::GetFiducialItem" ref="a557bb686a0554ceef9534f06dd939196" args="(uint32_t aIndex) const " -->
<a class="el" href="structplayer__fiducial__item.html">player_fiducial_item_t</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPlayerCc_1_1FiducialProxy.html#a557bb686a0554ceef9534f06dd939196">GetFiducialItem</a> (uint32_t aIndex) const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get detected beacon description. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac8f45730016c01932e6cd5df44165d36"></a><!-- doxytag: member="PlayerCc::FiducialProxy::GetSensorPose" ref="ac8f45730016c01932e6cd5df44165d36" args="() const " -->
<a class="el" href="structplayer__pose3d.html">player_pose3d_t</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPlayerCc_1_1FiducialProxy.html#ac8f45730016c01932e6cd5df44165d36">GetSensorPose</a> () const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The pose of the sensor. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8387707b87b97dbda6d3f3f2eb7a22f5"></a><!-- doxytag: member="PlayerCc::FiducialProxy::GetSensorSize" ref="a8387707b87b97dbda6d3f3f2eb7a22f5" args="() const " -->
<a class="el" href="structplayer__bbox3d.html">player_bbox3d_t</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPlayerCc_1_1FiducialProxy.html#a8387707b87b97dbda6d3f3f2eb7a22f5">GetSensorSize</a> () const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The size of the sensor. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5f4ecf4aba3cd84e4b4bc715685af7a5"></a><!-- doxytag: member="PlayerCc::FiducialProxy::GetFiducialSize" ref="a5f4ecf4aba3cd84e4b4bc715685af7a5" args="() const " -->
<a class="el" href="structplayer__bbox2d.html">player_bbox2d_t</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPlayerCc_1_1FiducialProxy.html#a5f4ecf4aba3cd84e4b4bc715685af7a5">GetFiducialSize</a> () const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The size of the most recently detected fiducial. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4116b020d8a975f366415648ce435fc7"></a><!-- doxytag: member="PlayerCc::FiducialProxy::RequestGeometry" ref="a4116b020d8a975f366415648ce435fc7" args="()" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPlayerCc_1_1FiducialProxy.html#a4116b020d8a975f366415648ce435fc7">RequestGeometry</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the sensor's geometry configuration. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="structplayer__fiducial__item.html">player_fiducial_item_t</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPlayerCc_1_1FiducialProxy.html#aa65a06f2c16f4067491eddca1735da1a">operator[]</a> (uint32_t aIndex) const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight"><a class="el" href="classPlayerCc_1_1FiducialProxy.html" title="The FiducialProxy class is used to control fiducial devices.">FiducialProxy</a> data access operator.  <a href="#aa65a06f2c16f4067491eddca1735da1a"></a><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="a7fc36a56067e8b80257412adcff08c99"></a><!-- doxytag: member="PlayerCc::FiducialProxy::Subscribe" ref="a7fc36a56067e8b80257412adcff08c99" 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="afb5ea11ddafc191945a5f67a58ca9e2f"></a><!-- doxytag: member="PlayerCc::FiducialProxy::Unsubscribe" ref="afb5ea11ddafc191945a5f67a58ca9e2f" 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="aa176f6db9ce55246f60cf48a368eec38"></a><!-- doxytag: member="PlayerCc::FiducialProxy::mDevice" ref="aa176f6db9ce55246f60cf48a368eec38" args="" -->
<a class="el" href="structplayerc__fiducial__t.html">playerc_fiducial_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_1FiducialProxy.html" title="The FiducialProxy class is used to control fiducial devices.">FiducialProxy</a></code> class is used to control <a class="el" href="group__interface__fiducial.html">fiducial</a> devices. </p>
<p>The latest set of detected beacons is stored in the <code>beacons</code> array. </p>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="aa65a06f2c16f4067491eddca1735da1a"></a><!-- doxytag: member="PlayerCc::FiducialProxy::operator[]" ref="aa65a06f2c16f4067491eddca1735da1a" args="(uint32_t aIndex) const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="structplayer__fiducial__item.html">player_fiducial_item_t</a> PlayerCc::FiducialProxy::operator[] </td>
          <td>(</td>
          <td class="paramtype">uint32_t&nbsp;</td>
          <td class="paramname"> <em>aIndex</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p><a class="el" href="classPlayerCc_1_1FiducialProxy.html" title="The FiducialProxy class is used to control fiducial devices.">FiducialProxy</a> data access operator. </p>
<p>This operator provides an alternate way of access the actuator data. For example, given a <code><a class="el" href="classPlayerCc_1_1FiducialProxy.html" title="The FiducialProxy class is used to control fiducial devices.">FiducialProxy</a></code> named <code>fp</code>, the following expressions are equivalent: <code>fp.GetFiducialItem</code>[0] and <code>fp</code>[0]. </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