<!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_1PlannerProxy.html">PlayerCc::PlannerProxy</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::PlannerProxy 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::PlannerProxy" --><!-- doxytag: inherits="PlayerCc::ClientProxy" -->
<p>The <code><a class="el" href="classPlayerCc_1_1PlannerProxy.html" title="The PlannerProxy proxy provides an interface to a 2D motion planner.">PlannerProxy</a></code> proxy provides an interface to a 2D motion <a class="el" href="group__interface__planner.html">planner</a>.
<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::PlannerProxy:</div>
<div class="dyncontent">
<div class="center">
<img src="classPlayerCc_1_1PlannerProxy.png" usemap="#PlayerCc::PlannerProxy_map" alt=""/>
<map id="PlayerCc::PlannerProxy_map" name="PlayerCc::PlannerProxy_map">
<area href="classPlayerCc_1_1ClientProxy.html" alt="PlayerCc::ClientProxy" shape="rect" coords="0,0,148,24"/>
</map>
</div>
<p><a href="classPlayerCc_1_1PlannerProxy-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="a94ff22803293b0152edb10dea5e34ada"></a><!-- doxytag: member="PlayerCc::PlannerProxy::PlannerProxy" ref="a94ff22803293b0152edb10dea5e34ada" args="(PlayerClient *aPc, uint32_t aIndex=0)" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="classPlayerCc_1_1PlannerProxy.html#a94ff22803293b0152edb10dea5e34ada">PlannerProxy</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="a2bf0b3f040c2f62914261d3998fbfec3"></a><!-- doxytag: member="PlayerCc::PlannerProxy::~PlannerProxy" ref="a2bf0b3f040c2f62914261d3998fbfec3" args="()" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="classPlayerCc_1_1PlannerProxy.html#a2bf0b3f040c2f62914261d3998fbfec3">~PlannerProxy</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="afc4fe207d5ffb2df8ff6544be9382f76"></a><!-- doxytag: member="PlayerCc::PlannerProxy::SetGoalPose" ref="afc4fe207d5ffb2df8ff6544be9382f76" args="(double aGx, double aGy, double aGa)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPlayerCc_1_1PlannerProxy.html#afc4fe207d5ffb2df8ff6544be9382f76">SetGoalPose</a> (double aGx, double aGy, double aGa)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the goal pose (gx, gy, ga). <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPlayerCc_1_1PlannerProxy.html#a07b055dcc37a57cf2fa2c3868d4e403d">RequestWaypoints</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the list of waypoints. <a href="#a07b055dcc37a57cf2fa2c3868d4e403d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPlayerCc_1_1PlannerProxy.html#aca90dc071f0c717447c700490a796910">SetEnable</a> (bool aEnable)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Enable/disable the robot's motion. <a href="#aca90dc071f0c717447c700490a796910"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a96b113c10b161ac2fb65ebc097a12765"></a><!-- doxytag: member="PlayerCc::PlannerProxy::GetPathValid" ref="a96b113c10b161ac2fb65ebc097a12765" args="() const " -->
uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classPlayerCc_1_1PlannerProxy.html#a96b113c10b161ac2fb65ebc097a12765">GetPathValid</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Did the planner find a valid path? <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a38f6b13e89943c1b929b568667434acb"></a><!-- doxytag: member="PlayerCc::PlannerProxy::GetPathDone" ref="a38f6b13e89943c1b929b568667434acb" args="() const " -->
uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classPlayerCc_1_1PlannerProxy.html#a38f6b13e89943c1b929b568667434acb">GetPathDone</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Have we arrived at the goal? <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="classPlayerCc_1_1PlannerProxy.html#a1e354722e6fb98ad43fbc814008132f9">GetPx</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Current pose (m). <a href="#a1e354722e6fb98ad43fbc814008132f9"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="classPlayerCc_1_1PlannerProxy.html#ac9194c7141063a32d9df7886cd21187e">GetPy</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Current pose (m). <a href="#ac9194c7141063a32d9df7886cd21187e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="classPlayerCc_1_1PlannerProxy.html#a0c09637af1be25a0dae758eb56ce6867">GetPa</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Current pose (radians). <a href="#a0c09637af1be25a0dae758eb56ce6867"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a949228a0e4eae351456bf2ca5b72f438"></a><!-- doxytag: member="PlayerCc::PlannerProxy::GetPose" ref="a949228a0e4eae351456bf2ca5b72f438" args="() const " -->
<a class="el" href="structplayer__pose2d.html">player_pose2d_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPlayerCc_1_1PlannerProxy.html#a949228a0e4eae351456bf2ca5b72f438">GetPose</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the current pose. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="classPlayerCc_1_1PlannerProxy.html#ae6cfacc70d299067cb4bfcb329a56769">GetGx</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Goal location (m). <a href="#ae6cfacc70d299067cb4bfcb329a56769"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="classPlayerCc_1_1PlannerProxy.html#a51017009b2b0d7c98df002220646de69">GetGy</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Goal location (m). <a href="#a51017009b2b0d7c98df002220646de69"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="classPlayerCc_1_1PlannerProxy.html#a700366fc50a5f1fd1118e8b519b2a405">GetGa</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Goal location (radians). <a href="#a700366fc50a5f1fd1118e8b519b2a405"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae5edb8945871e306e179be68f9f87d47"></a><!-- doxytag: member="PlayerCc::PlannerProxy::GetGoal" ref="ae5edb8945871e306e179be68f9f87d47" args="() const " -->
<a class="el" href="structplayer__pose2d.html">player_pose2d_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPlayerCc_1_1PlannerProxy.html#ae5edb8945871e306e179be68f9f87d47">GetGoal</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the goal. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="classPlayerCc_1_1PlannerProxy.html#a104cb460917ef433ae1d167502d15f39">GetWx</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Current waypoint location (m). <a href="#a104cb460917ef433ae1d167502d15f39"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="classPlayerCc_1_1PlannerProxy.html#a5db4247a10afc54e03fb20834e2ea9a3">GetWy</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Current waypoint location (m). <a href="#a5db4247a10afc54e03fb20834e2ea9a3"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="classPlayerCc_1_1PlannerProxy.html#a335a7f9c2e187b292051b3695570c3e4">GetWa</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Current waypoint location (rad). <a href="#a335a7f9c2e187b292051b3695570c3e4"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a00590c7b29abfdad92e4ceefe5290699"></a><!-- doxytag: member="PlayerCc::PlannerProxy::GetCurrentWaypoint" ref="a00590c7b29abfdad92e4ceefe5290699" args="() const " -->
<a class="el" href="structplayer__pose2d.html">player_pose2d_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPlayerCc_1_1PlannerProxy.html#a00590c7b29abfdad92e4ceefe5290699">GetCurrentWaypoint</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the current waypoint. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="classPlayerCc_1_1PlannerProxy.html#a2d55325a9842b2598da803e07a1179bb">GetIx</a> (int i) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Grab a particular waypoint location (m). <a href="#a2d55325a9842b2598da803e07a1179bb"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="classPlayerCc_1_1PlannerProxy.html#a8b0d771bc6b9de7108a2222dd957f75c">GetIy</a> (int i) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Grab a particular waypoint location (m). <a href="#a8b0d771bc6b9de7108a2222dd957f75c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="classPlayerCc_1_1PlannerProxy.html#afccedf325e80c1b3927ed74ddc6efd61">GetIa</a> (int i) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Grab a particular waypoint location (rad). <a href="#afccedf325e80c1b3927ed74ddc6efd61"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac511d93181b3a19961982653d472fe2e"></a><!-- doxytag: member="PlayerCc::PlannerProxy::GetWaypoint" ref="ac511d93181b3a19961982653d472fe2e" args="(uint32_t aIndex) const " -->
<a class="el" href="structplayer__pose2d.html">player_pose2d_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPlayerCc_1_1PlannerProxy.html#ac511d93181b3a19961982653d472fe2e">GetWaypoint</a> (uint32_t aIndex) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the waypoint. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classPlayerCc_1_1PlannerProxy.html#a318bbb2899eac434c0584c94f91ed5c6">GetCurrentWaypointId</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Current waypoint index (handy if you already have the list of waypoints). <a href="#a318bbb2899eac434c0584c94f91ed5c6"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5fd4ad4e48ed35a5adb74fd333db120f"></a><!-- doxytag: member="PlayerCc::PlannerProxy::GetWaypointCount" ref="a5fd4ad4e48ed35a5adb74fd333db120f" args="() const " -->
uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classPlayerCc_1_1PlannerProxy.html#a5fd4ad4e48ed35a5adb74fd333db120f">GetWaypointCount</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Number of waypoints in the plan. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="structplayer__pose2d.html">player_pose2d_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPlayerCc_1_1PlannerProxy.html#a380516c87f2ab74e55aea8becdced94f">operator[]</a> (uint32_t aIndex) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Waypoint access operator This operator provides an alternate way of access the waypoint data. <a href="#a380516c87f2ab74e55aea8becdced94f"></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="a5323e3a645cf9007e622819f4b0eaaf2"></a><!-- doxytag: member="PlayerCc::PlannerProxy::Subscribe" ref="a5323e3a645cf9007e622819f4b0eaaf2" 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="a877eb52d7ac0b4ba599db4b279ca8ccc"></a><!-- doxytag: member="PlayerCc::PlannerProxy::Unsubscribe" ref="a877eb52d7ac0b4ba599db4b279ca8ccc" 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="a4a32af2568f79895b5f5b41913176f6f"></a><!-- doxytag: member="PlayerCc::PlannerProxy::mDevice" ref="a4a32af2568f79895b5f5b41913176f6f" args="" -->
<a class="el" href="structplayerc__planner__t.html">playerc_planner_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_1PlannerProxy.html" title="The PlannerProxy proxy provides an interface to a 2D motion planner.">PlannerProxy</a></code> proxy provides an interface to a 2D motion <a class="el" href="group__interface__planner.html">planner</a>. </p>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a318bbb2899eac434c0584c94f91ed5c6"></a><!-- doxytag: member="PlayerCc::PlannerProxy::GetCurrentWaypointId" ref="a318bbb2899eac434c0584c94f91ed5c6" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int PlayerCc::PlannerProxy::GetCurrentWaypointId </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Current waypoint index (handy if you already have the list of waypoints). </p>
<p>May be negative if there's no plan, or if the plan is done </p>
</div>
</div>
<a class="anchor" id="a700366fc50a5f1fd1118e8b519b2a405"></a><!-- doxytag: member="PlayerCc::PlannerProxy::GetGa" ref="a700366fc50a5f1fd1118e8b519b2a405" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double PlayerCc::PlannerProxy::GetGa </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Goal location (radians). </p>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000008">Deprecated:</a></b></dt><dd>use <a class="el" href="classPlayerCc_1_1PlannerProxy.html#ae5edb8945871e306e179be68f9f87d47" title="Get the goal.">GetGoal()</a> instead </dd></dl>
</div>
</div>
<a class="anchor" id="ae6cfacc70d299067cb4bfcb329a56769"></a><!-- doxytag: member="PlayerCc::PlannerProxy::GetGx" ref="ae6cfacc70d299067cb4bfcb329a56769" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double PlayerCc::PlannerProxy::GetGx </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Goal location (m). </p>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000006">Deprecated:</a></b></dt><dd>use <a class="el" href="classPlayerCc_1_1PlannerProxy.html#ae5edb8945871e306e179be68f9f87d47" title="Get the goal.">GetGoal()</a> instead </dd></dl>
</div>
</div>
<a class="anchor" id="a51017009b2b0d7c98df002220646de69"></a><!-- doxytag: member="PlayerCc::PlannerProxy::GetGy" ref="a51017009b2b0d7c98df002220646de69" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double PlayerCc::PlannerProxy::GetGy </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Goal location (m). </p>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000007">Deprecated:</a></b></dt><dd>use <a class="el" href="classPlayerCc_1_1PlannerProxy.html#ae5edb8945871e306e179be68f9f87d47" title="Get the goal.">GetGoal()</a> instead </dd></dl>
</div>
</div>
<a class="anchor" id="afccedf325e80c1b3927ed74ddc6efd61"></a><!-- doxytag: member="PlayerCc::PlannerProxy::GetIa" ref="afccedf325e80c1b3927ed74ddc6efd61" args="(int i) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double PlayerCc::PlannerProxy::GetIa </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>i</em></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Grab a particular waypoint location (rad). </p>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000014">Deprecated:</a></b></dt><dd>use <a class="el" href="classPlayerCc_1_1PlannerProxy.html#ac511d93181b3a19961982653d472fe2e" title="Get the waypoint.">GetWaypoint()</a> instead </dd></dl>
</div>
</div>
<a class="anchor" id="a2d55325a9842b2598da803e07a1179bb"></a><!-- doxytag: member="PlayerCc::PlannerProxy::GetIx" ref="a2d55325a9842b2598da803e07a1179bb" args="(int i) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double PlayerCc::PlannerProxy::GetIx </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>i</em></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Grab a particular waypoint location (m). </p>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000012">Deprecated:</a></b></dt><dd>use <a class="el" href="classPlayerCc_1_1PlannerProxy.html#ac511d93181b3a19961982653d472fe2e" title="Get the waypoint.">GetWaypoint()</a> instead </dd></dl>
</div>
</div>
<a class="anchor" id="a8b0d771bc6b9de7108a2222dd957f75c"></a><!-- doxytag: member="PlayerCc::PlannerProxy::GetIy" ref="a8b0d771bc6b9de7108a2222dd957f75c" args="(int i) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double PlayerCc::PlannerProxy::GetIy </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>i</em></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Grab a particular waypoint location (m). </p>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000013">Deprecated:</a></b></dt><dd>use <a class="el" href="classPlayerCc_1_1PlannerProxy.html#ac511d93181b3a19961982653d472fe2e" title="Get the waypoint.">GetWaypoint()</a> instead </dd></dl>
</div>
</div>
<a class="anchor" id="a0c09637af1be25a0dae758eb56ce6867"></a><!-- doxytag: member="PlayerCc::PlannerProxy::GetPa" ref="a0c09637af1be25a0dae758eb56ce6867" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double PlayerCc::PlannerProxy::GetPa </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Current pose (radians). </p>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000005">Deprecated:</a></b></dt><dd>use <a class="el" href="classPlayerCc_1_1PlannerProxy.html#a949228a0e4eae351456bf2ca5b72f438" title="Get the current pose.">GetPose()</a> instead </dd></dl>
</div>
</div>
<a class="anchor" id="a1e354722e6fb98ad43fbc814008132f9"></a><!-- doxytag: member="PlayerCc::PlannerProxy::GetPx" ref="a1e354722e6fb98ad43fbc814008132f9" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double PlayerCc::PlannerProxy::GetPx </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Current pose (m). </p>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000003">Deprecated:</a></b></dt><dd>use <a class="el" href="classPlayerCc_1_1PlannerProxy.html#a949228a0e4eae351456bf2ca5b72f438" title="Get the current pose.">GetPose()</a> instead </dd></dl>
</div>
</div>
<a class="anchor" id="ac9194c7141063a32d9df7886cd21187e"></a><!-- doxytag: member="PlayerCc::PlannerProxy::GetPy" ref="ac9194c7141063a32d9df7886cd21187e" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double PlayerCc::PlannerProxy::GetPy </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Current pose (m). </p>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000004">Deprecated:</a></b></dt><dd>use <a class="el" href="classPlayerCc_1_1PlannerProxy.html#a949228a0e4eae351456bf2ca5b72f438" title="Get the current pose.">GetPose()</a> instead </dd></dl>
</div>
</div>
<a class="anchor" id="a335a7f9c2e187b292051b3695570c3e4"></a><!-- doxytag: member="PlayerCc::PlannerProxy::GetWa" ref="a335a7f9c2e187b292051b3695570c3e4" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double PlayerCc::PlannerProxy::GetWa </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Current waypoint location (rad). </p>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000011">Deprecated:</a></b></dt><dd>use GetCurWaypoint() instead </dd></dl>
</div>
</div>
<a class="anchor" id="a104cb460917ef433ae1d167502d15f39"></a><!-- doxytag: member="PlayerCc::PlannerProxy::GetWx" ref="a104cb460917ef433ae1d167502d15f39" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double PlayerCc::PlannerProxy::GetWx </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Current waypoint location (m). </p>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000009">Deprecated:</a></b></dt><dd>use GetCurWaypoint() instead </dd></dl>
</div>
</div>
<a class="anchor" id="a5db4247a10afc54e03fb20834e2ea9a3"></a><!-- doxytag: member="PlayerCc::PlannerProxy::GetWy" ref="a5db4247a10afc54e03fb20834e2ea9a3" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double PlayerCc::PlannerProxy::GetWy </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Current waypoint location (m). </p>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000010">Deprecated:</a></b></dt><dd>use GetCurWaypoint() instead </dd></dl>
</div>
</div>
<a class="anchor" id="a380516c87f2ab74e55aea8becdced94f"></a><!-- doxytag: member="PlayerCc::PlannerProxy::operator[]" ref="a380516c87f2ab74e55aea8becdced94f" args="(uint32_t aIndex) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structplayer__pose2d.html">player_pose2d_t</a> PlayerCc::PlannerProxy::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>Waypoint access operator This operator provides an alternate way of access the waypoint data. </p>
<p>For example, given a <code><a class="el" href="classPlayerCc_1_1PlannerProxy.html" title="The PlannerProxy proxy provides an interface to a 2D motion planner.">PlannerProxy</a></code> named <code>pp</code>, the following expressions are equivalent: <code>pp.GetWaypoint(0)</code> and <code>pp</code>[0]. </p>
</div>
</div>
<a class="anchor" id="a07b055dcc37a57cf2fa2c3868d4e403d"></a><!-- doxytag: member="PlayerCc::PlannerProxy::RequestWaypoints" ref="a07b055dcc37a57cf2fa2c3868d4e403d" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void PlayerCc::PlannerProxy::RequestWaypoints </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the list of waypoints. </p>
<p>Writes the result into the proxy rather than returning it to the caller. </p>
</div>
</div>
<a class="anchor" id="aca90dc071f0c717447c700490a796910"></a><!-- doxytag: member="PlayerCc::PlannerProxy::SetEnable" ref="aca90dc071f0c717447c700490a796910" args="(bool aEnable)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void PlayerCc::PlannerProxy::SetEnable </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>aEnable</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Enable/disable the robot's motion. </p>
<p>Set state 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>
distrib
>
Fedora
>
14
>
x86_64
>
media
>
updates
>
by-pkgid
>
727fa15453fcace956b835e2377d4269
>
files
>
275
