Sophie

Sophie

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

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_1RangerProxy.html">PlayerCc::RangerProxy</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::RangerProxy 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::RangerProxy" --><!-- doxytag: inherits="PlayerCc::ClientProxy" -->
<p>The <code><a class="el" href="classPlayerCc_1_1RangerProxy.html" title="The RangerProxy class is used to control a ranger device.">RangerProxy</a></code> class is used to control a <a class="el" href="group__interface__ranger.html">ranger</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::RangerProxy:</div>
<div class="dyncontent">
 <div class="center">
  <img src="classPlayerCc_1_1RangerProxy.png" usemap="#PlayerCc::RangerProxy_map" alt=""/>
  <map id="PlayerCc::RangerProxy_map" name="PlayerCc::RangerProxy_map">
<area href="classPlayerCc_1_1ClientProxy.html" alt="PlayerCc::ClientProxy" shape="rect" coords="0,0,145,24"/>
</map>
</div>

<p><a href="classPlayerCc_1_1RangerProxy-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="a672f6314024a32007de6ee95b6fd3e1d"></a><!-- doxytag: member="PlayerCc::RangerProxy::RangerProxy" ref="a672f6314024a32007de6ee95b6fd3e1d" args="(PlayerClient *aPc, uint32_t aIndex=0)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPlayerCc_1_1RangerProxy.html#a672f6314024a32007de6ee95b6fd3e1d">RangerProxy</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="a7b75940fead031c1ef22cdf104763c92"></a><!-- doxytag: member="PlayerCc::RangerProxy::~RangerProxy" ref="a7b75940fead031c1ef22cdf104763c92" args="()" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPlayerCc_1_1RangerProxy.html#a7b75940fead031c1ef22cdf104763c92">~RangerProxy</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="a1f723d01963c28bbe0aaee2a475920c5"></a><!-- doxytag: member="PlayerCc::RangerProxy::GetElementCount" ref="a1f723d01963c28bbe0aaee2a475920c5" args="() const " -->
uint32_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPlayerCc_1_1RangerProxy.html#a1f723d01963c28bbe0aaee2a475920c5">GetElementCount</a> () const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the individual range sensor count. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a643dea09bfc94a7ffd7484167f11eff4"></a><!-- doxytag: member="PlayerCc::RangerProxy::GetDevicePose" ref="a643dea09bfc94a7ffd7484167f11eff4" 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_1RangerProxy.html#a643dea09bfc94a7ffd7484167f11eff4">GetDevicePose</a> () const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the device pose. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a82a8e4e7489afa974174ffb7982491aa"></a><!-- doxytag: member="PlayerCc::RangerProxy::GetDeviceSize" ref="a82a8e4e7489afa974174ffb7982491aa" 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_1RangerProxy.html#a82a8e4e7489afa974174ffb7982491aa">GetDeviceSize</a> () const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the device size. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aaeaa7eebc8476abd9be00bf667b25f34"></a><!-- doxytag: member="PlayerCc::RangerProxy::GetElementPose" ref="aaeaa7eebc8476abd9be00bf667b25f34" args="(uint32_t aIndex) 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_1RangerProxy.html#aaeaa7eebc8476abd9be00bf667b25f34">GetElementPose</a> (uint32_t aIndex) const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the pose of an individual sensor. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="adb364235990281c998c8ecea003ec3ad"></a><!-- doxytag: member="PlayerCc::RangerProxy::GetElementSize" ref="adb364235990281c998c8ecea003ec3ad" args="(uint32_t aIndex) 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_1RangerProxy.html#adb364235990281c998c8ecea003ec3ad">GetElementSize</a> (uint32_t aIndex) const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the size of an individual sensor. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae947c501f640e4096293cb1b52dbb485"></a><!-- doxytag: member="PlayerCc::RangerProxy::GetRangeCount" ref="ae947c501f640e4096293cb1b52dbb485" args="() const " -->
uint32_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPlayerCc_1_1RangerProxy.html#ae947c501f640e4096293cb1b52dbb485">GetRangeCount</a> () const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the number of range readings. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a44dd8ecc029fb915bc5a72f33c46a479"></a><!-- doxytag: member="PlayerCc::RangerProxy::GetRange" ref="a44dd8ecc029fb915bc5a72f33c46a479" args="(uint32_t aIndex) const " -->
double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPlayerCc_1_1RangerProxy.html#a44dd8ecc029fb915bc5a72f33c46a479">GetRange</a> (uint32_t aIndex) const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get a range reading. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afcdee96d71578ca1f7106c0e609fe5e7"></a><!-- doxytag: member="PlayerCc::RangerProxy::operator[]" ref="afcdee96d71578ca1f7106c0e609fe5e7" args="(uint32_t aIndex) const " -->
double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPlayerCc_1_1RangerProxy.html#afcdee96d71578ca1f7106c0e609fe5e7">operator[]</a> (uint32_t aIndex) const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Operator to get a range reading. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aaf6a9c51c3274c527da1f4f1328b54d4"></a><!-- doxytag: member="PlayerCc::RangerProxy::GetIntensityCount" ref="aaf6a9c51c3274c527da1f4f1328b54d4" args="() const " -->
uint32_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPlayerCc_1_1RangerProxy.html#aaf6a9c51c3274c527da1f4f1328b54d4">GetIntensityCount</a> () const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the number of intensity readings. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8e61b733cc1347dcfd5911237d4a8480"></a><!-- doxytag: member="PlayerCc::RangerProxy::GetIntensity" ref="a8e61b733cc1347dcfd5911237d4a8480" args="(uint32_t aIndex) const " -->
double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPlayerCc_1_1RangerProxy.html#a8e61b733cc1347dcfd5911237d4a8480">GetIntensity</a> (uint32_t aIndex) const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get an intensity reading. <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_1RangerProxy.html#a6991af040819a05bdeb86ce83844eecf">SetPower</a> (bool aEnable)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Turn the device power on or off.  <a href="#a6991af040819a05bdeb86ce83844eecf"></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_1RangerProxy.html#a4124de488928cb2afbf1b9b9b584a8d5">SetIntensityData</a> (bool aEnable)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Turn intensity data on or off.  <a href="#a4124de488928cb2afbf1b9b9b584a8d5"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afaf7f68d5f30498ce49ba9e1f2e2c6c1"></a><!-- doxytag: member="PlayerCc::RangerProxy::RequestGeom" ref="afaf7f68d5f30498ce49ba9e1f2e2c6c1" args="()" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPlayerCc_1_1RangerProxy.html#afaf7f68d5f30498ce49ba9e1f2e2c6c1">RequestGeom</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Request the ranger geometry. <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_1RangerProxy.html#af3edd3dc264564072571c41655a67932">Configure</a> (double aMinAngle, double aMaxAngle, double aAngularRes, double aMinRange, double aMaxRange, double aRangeRes, double aFrequency)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Configure the ranger scan pattern.  <a href="#af3edd3dc264564072571c41655a67932"></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_1RangerProxy.html#a4b6f7910bae06680b1716a7ef4ea9863">RequestConfigure</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the current ranger configuration; it is read into the relevant class attributes.  <a href="#a4b6f7910bae06680b1716a7ef4ea9863"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a17eadd10d698f50fde113f80fbbeb118"></a><!-- doxytag: member="PlayerCc::RangerProxy::GetMinAngle" ref="a17eadd10d698f50fde113f80fbbeb118" args="() const " -->
double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPlayerCc_1_1RangerProxy.html#a17eadd10d698f50fde113f80fbbeb118">GetMinAngle</a> () const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Start angle of a scan (configured value). <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a11cba57b4fe134aa0adb0624ea1dcd36"></a><!-- doxytag: member="PlayerCc::RangerProxy::GetMaxAngle" ref="a11cba57b4fe134aa0adb0624ea1dcd36" args="() const " -->
double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPlayerCc_1_1RangerProxy.html#a11cba57b4fe134aa0adb0624ea1dcd36">GetMaxAngle</a> () const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Stop angle of a scan (configured value). <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac134458b232f379e8e05c46856935cbb"></a><!-- doxytag: member="PlayerCc::RangerProxy::GetAngularRes" ref="ac134458b232f379e8e05c46856935cbb" args="() const " -->
double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPlayerCc_1_1RangerProxy.html#ac134458b232f379e8e05c46856935cbb">GetAngularRes</a> () const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Angular resolution of a scan (configured value). <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa6d4e3574a534965e60b5f250e46c011"></a><!-- doxytag: member="PlayerCc::RangerProxy::GetMinRange" ref="aa6d4e3574a534965e60b5f250e46c011" args="() const " -->
double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPlayerCc_1_1RangerProxy.html#aa6d4e3574a534965e60b5f250e46c011">GetMinRange</a> () const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Minimum detectable range of a scan (configured value). <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0fab68f522747e6591c7a96253e31d05"></a><!-- doxytag: member="PlayerCc::RangerProxy::GetMaxRange" ref="a0fab68f522747e6591c7a96253e31d05" args="() const " -->
double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPlayerCc_1_1RangerProxy.html#a0fab68f522747e6591c7a96253e31d05">GetMaxRange</a> () const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Maximum detectable range of a scan (configured value). <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a971ab14b7fa08b8631c377e62dfd43d6"></a><!-- doxytag: member="PlayerCc::RangerProxy::GetRangeRes" ref="a971ab14b7fa08b8631c377e62dfd43d6" args="() const " -->
double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPlayerCc_1_1RangerProxy.html#a971ab14b7fa08b8631c377e62dfd43d6">GetRangeRes</a> () const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Linear resolution (configured value). <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab060df0f8a4e06e4ad6fac9c2749701e"></a><!-- doxytag: member="PlayerCc::RangerProxy::GetFrequency" ref="ab060df0f8a4e06e4ad6fac9c2749701e" args="() const " -->
double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPlayerCc_1_1RangerProxy.html#ab060df0f8a4e06e4ad6fac9c2749701e">GetFrequency</a> () const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Scanning frequency (configured value). <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="adac26f83acb2a26cee86530b1ffebc6b"></a><!-- doxytag: member="PlayerCc::RangerProxy::Subscribe" ref="adac26f83acb2a26cee86530b1ffebc6b" 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="a5289b249ecb45488697ae95c2281cee1"></a><!-- doxytag: member="PlayerCc::RangerProxy::Unsubscribe" ref="a5289b249ecb45488697ae95c2281cee1" 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="a00fb09f8b0250b666dfaf799581cc74a"></a><!-- doxytag: member="PlayerCc::RangerProxy::mDevice" ref="a00fb09f8b0250b666dfaf799581cc74a" args="" -->
<a class="el" href="structplayerc__ranger__t.html">playerc_ranger_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_1RangerProxy.html" title="The RangerProxy class is used to control a ranger device.">RangerProxy</a></code> class is used to control a <a class="el" href="group__interface__ranger.html">ranger</a> device. </p>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="af3edd3dc264564072571c41655a67932"></a><!-- doxytag: member="PlayerCc::RangerProxy::Configure" ref="af3edd3dc264564072571c41655a67932" args="(double aMinAngle, double aMaxAngle, double aAngularRes, double aMinRange, double aMaxRange, double aRangeRes, double aFrequency)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void PlayerCc::RangerProxy::Configure </td>
          <td>(</td>
          <td class="paramtype">double&nbsp;</td>
          <td class="paramname"> <em>aMinAngle</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">double&nbsp;</td>
          <td class="paramname"> <em>aMaxAngle</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">double&nbsp;</td>
          <td class="paramname"> <em>aAngularRes</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">double&nbsp;</td>
          <td class="paramname"> <em>aMinRange</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">double&nbsp;</td>
          <td class="paramname"> <em>aMaxRange</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">double&nbsp;</td>
          <td class="paramname"> <em>aRangeRes</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">double&nbsp;</td>
          <td class="paramname"> <em>aFrequency</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Configure the ranger scan pattern. </p>
<p>Angles <code>aMinAngle</code> and <code>aMaxAngle</code> are measured in radians. <code>aResolution</code> is measured in radians. <code>aMinRange</code>, <code>aMaxRange</code> and <code>aRangeRes</code> is measured in metres. <code>aFrequency</code> is measured in Hz. </p>

</div>
</div>
<a class="anchor" id="a4b6f7910bae06680b1716a7ef4ea9863"></a><!-- doxytag: member="PlayerCc::RangerProxy::RequestConfigure" ref="a4b6f7910bae06680b1716a7ef4ea9863" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void PlayerCc::RangerProxy::RequestConfigure </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Get the current ranger configuration; it is read into the relevant class attributes. </p>

</div>
</div>
<a class="anchor" id="a4124de488928cb2afbf1b9b9b584a8d5"></a><!-- doxytag: member="PlayerCc::RangerProxy::SetIntensityData" ref="a4124de488928cb2afbf1b9b9b584a8d5" args="(bool aEnable)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void PlayerCc::RangerProxy::SetIntensityData </td>
          <td>(</td>
          <td class="paramtype">bool&nbsp;</td>
          <td class="paramname"> <em>aEnable</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Turn intensity data on or off. </p>
<p>Set <code>state</code> to true to enable, false to disable. </p>

</div>
</div>
<a class="anchor" id="a6991af040819a05bdeb86ce83844eecf"></a><!-- doxytag: member="PlayerCc::RangerProxy::SetPower" ref="a6991af040819a05bdeb86ce83844eecf" args="(bool aEnable)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void PlayerCc::RangerProxy::SetPower </td>
          <td>(</td>
          <td class="paramtype">bool&nbsp;</td>
          <td class="paramname"> <em>aEnable</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Turn the device power on or off. </p>
<p>Set <code>state</code> to true to enable, false to disable. </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>