<!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="navpath"> <ul> <li><b>PlayerCc</b> </li> <li><a class="el" href="classPlayerCc_1_1IrProxy.html">PlayerCc::IrProxy</a> </li> </ul> </div> <div class="header"> <div class="summary"> <a href="#pub-methods">Public Member Functions</a> | <a href="#pri-methods">Private Member Functions</a> | <a href="#pri-attribs">Private Attributes</a> </div> <div class="headertitle"> <h1>PlayerCc::IrProxy 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::IrProxy" --><!-- doxytag: inherits="PlayerCc::ClientProxy" --> <p>The <code><a class="el" href="classPlayerCc_1_1IrProxy.html" title="The IrProxy class is used to control an ir device.">IrProxy</a></code> class is used to control an <a class="el" href="group__interface__ir.html">ir</a> device. <a href="#_details">More...</a></p> <p><code>#include <<a class="el" href="playerc_09_09_8h_source.html">playerc++.h</a>></code></p> <div class="dynheader"> Inheritance diagram for PlayerCc::IrProxy:</div> <div class="dyncontent"> <div class="center"> <img src="classPlayerCc_1_1IrProxy.png" usemap="#PlayerCc::IrProxy_map" alt=""/> <map id="PlayerCc::IrProxy_map" name="PlayerCc::IrProxy_map"> <area href="classPlayerCc_1_1ClientProxy.html" alt="PlayerCc::ClientProxy" shape="rect" coords="0,0,136,24"/> </map> </div> <p><a href="classPlayerCc_1_1IrProxy-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="a3ef4c2d98c30cc6259169832b1dee1f6"></a><!-- doxytag: member="PlayerCc::IrProxy::IrProxy" ref="a3ef4c2d98c30cc6259169832b1dee1f6" args="(PlayerClient *aPc, uint32_t aIndex=0)" --> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPlayerCc_1_1IrProxy.html#a3ef4c2d98c30cc6259169832b1dee1f6">IrProxy</a> (<a class="el" href="classPlayerCc_1_1PlayerClient.html">PlayerClient</a> *aPc, uint32_t aIndex=0)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aeca0b78b38f33a9fd5f8f34b8b516751"></a><!-- doxytag: member="PlayerCc::IrProxy::~IrProxy" ref="aeca0b78b38f33a9fd5f8f34b8b516751" args="()" --> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPlayerCc_1_1IrProxy.html#aeca0b78b38f33a9fd5f8f34b8b516751">~IrProxy</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">destructor <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac0a878d6bc3e2e440563cf52a0dc0fcb"></a><!-- doxytag: member="PlayerCc::IrProxy::GetCount" ref="ac0a878d6bc3e2e440563cf52a0dc0fcb" args="() const " --> uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classPlayerCc_1_1IrProxy.html#ac0a878d6bc3e2e440563cf52a0dc0fcb">GetCount</a> () const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">get the number of IR rangers <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4f869b0c1c2a854cffe7520f152c9da5"></a><!-- doxytag: member="PlayerCc::IrProxy::GetRange" ref="a4f869b0c1c2a854cffe7520f152c9da5" args="(uint32_t aIndex) const " --> double </td><td class="memItemRight" valign="bottom"><a class="el" href="classPlayerCc_1_1IrProxy.html#a4f869b0c1c2a854cffe7520f152c9da5">GetRange</a> (uint32_t aIndex) const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">get the current range <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af62342b8e867033f041fb7046ffc2230"></a><!-- doxytag: member="PlayerCc::IrProxy::GetVoltage" ref="af62342b8e867033f041fb7046ffc2230" args="(uint32_t aIndex) const " --> double </td><td class="memItemRight" valign="bottom"><a class="el" href="classPlayerCc_1_1IrProxy.html#af62342b8e867033f041fb7046ffc2230">GetVoltage</a> (uint32_t aIndex) const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">get the current voltage <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7b8b4b5ce5359c431141a507db4a3c3a"></a><!-- doxytag: member="PlayerCc::IrProxy::GetPoseCount" ref="a7b8b4b5ce5359c431141a507db4a3c3a" args="() const " --> uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classPlayerCc_1_1IrProxy.html#a7b8b4b5ce5359c431141a507db4a3c3a">GetPoseCount</a> () const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">get the number of poses <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac3c991888cf54310962875efd7507c1b"></a><!-- doxytag: member="PlayerCc::IrProxy::GetPose" ref="ac3c991888cf54310962875efd7507c1b" args="(uint32_t aIndex) const " --> <a class="el" href="structplayer__pose3d.html">player_pose3d_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPlayerCc_1_1IrProxy.html#ac3c991888cf54310962875efd7507c1b">GetPose</a> (uint32_t aIndex) const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">get a particular pose <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af5a76e405bd9b90ffe2662ddde4cbec1"></a><!-- doxytag: member="PlayerCc::IrProxy::RequestGeom" ref="af5a76e405bd9b90ffe2662ddde4cbec1" args="()" --> void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPlayerCc_1_1IrProxy.html#af5a76e405bd9b90ffe2662ddde4cbec1">RequestGeom</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Request IR pose information. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="classPlayerCc_1_1IrProxy.html#a7fdd2599d99cbf959faf0864581a7b28">operator[]</a> (uint32_t aIndex) const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Range access operator. <a href="#a7fdd2599d99cbf959faf0864581a7b28"></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="a7d72550084fdd19a3ea455706c676656"></a><!-- doxytag: member="PlayerCc::IrProxy::Subscribe" ref="a7d72550084fdd19a3ea455706c676656" args="(uint32_t aIndex)" --> void </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="a9cff9fa167a58054385ad0e0fadd641d"></a><!-- doxytag: member="PlayerCc::IrProxy::Unsubscribe" ref="a9cff9fa167a58054385ad0e0fadd641d" args="()" --> void </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="a1708ffb1cd99dd8b59cb69c618db3069"></a><!-- doxytag: member="PlayerCc::IrProxy::mDevice" ref="a1708ffb1cd99dd8b59cb69c618db3069" args="" --> <a class="el" href="structplayerc__ir__t.html">playerc_ir_t</a> * </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_1IrProxy.html" title="The IrProxy class is used to control an ir device.">IrProxy</a></code> class is used to control an <a class="el" href="group__interface__ir.html">ir</a> device. </p> <hr/><h2>Member Function Documentation</h2> <a class="anchor" id="a7fdd2599d99cbf959faf0864581a7b28"></a><!-- doxytag: member="PlayerCc::IrProxy::operator[]" ref="a7fdd2599d99cbf959faf0864581a7b28" args="(uint32_t aIndex) const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">double PlayerCc::IrProxy::operator[] </td> <td>(</td> <td class="paramtype">uint32_t </td> <td class="paramname"> <em>aIndex</em></td> <td> ) </td> <td> const<code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Range access operator. </p> <p>This operator provides an alternate way of access the range data. For example, given a <code><a class="el" href="classPlayerCc_1_1IrProxy.html" title="The IrProxy class is used to control an ir device.">IrProxy</a></code> named <code>ip</code>, the following expressions are equivalent: <code>ip.GetRange</code>[0] and <code>ip</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>