<!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_1MapProxy.html">PlayerCc::MapProxy</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::MapProxy 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::MapProxy" --><!-- doxytag: inherits="PlayerCc::ClientProxy" --> <p>The <code>map</code> proxy provides access to a <a class="el" href="group__interface__map.html">map</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::MapProxy:</div> <div class="dyncontent"> <div class="center"> <img src="classPlayerCc_1_1MapProxy.png" usemap="#PlayerCc::MapProxy_map" alt=""/> <map id="PlayerCc::MapProxy_map" name="PlayerCc::MapProxy_map"> <area href="classPlayerCc_1_1ClientProxy.html" alt="PlayerCc::ClientProxy" shape="rect" coords="0,0,136,24"/> </map> </div> <p><a href="classPlayerCc_1_1MapProxy-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="a54ceba2f775e7530ef48822f41a88a98"></a><!-- doxytag: member="PlayerCc::MapProxy::MapProxy" ref="a54ceba2f775e7530ef48822f41a88a98" args="(PlayerClient *aPc, uint32_t aIndex=0)" --> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPlayerCc_1_1MapProxy.html#a54ceba2f775e7530ef48822f41a88a98">MapProxy</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="a13994be36b66ef5b1a8923299a14a0f3"></a><!-- doxytag: member="PlayerCc::MapProxy::~MapProxy" ref="a13994be36b66ef5b1a8923299a14a0f3" args="()" --> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPlayerCc_1_1MapProxy.html#a13994be36b66ef5b1a8923299a14a0f3">~MapProxy</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="a3897302638d2607102137d44d3a5297e"></a><!-- doxytag: member="PlayerCc::MapProxy::RequestMap" ref="a3897302638d2607102137d44d3a5297e" args="()" --> void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPlayerCc_1_1MapProxy.html#a3897302638d2607102137d44d3a5297e">RequestMap</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the map and store it in the proxy. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a677eea27d79f88c249c253d76661d6bc"></a><!-- doxytag: member="PlayerCc::MapProxy::GetCellIndex" ref="a677eea27d79f88c249c253d76661d6bc" args="(int x, int y) const " --> int </td><td class="memItemRight" valign="bottom"><a class="el" href="classPlayerCc_1_1MapProxy.html#a677eea27d79f88c249c253d76661d6bc">GetCellIndex</a> (int x, int y) const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Return the index of the (x,y) item in the cell array. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae0223523d460f6b6b470b2b30ffcd80c"></a><!-- doxytag: member="PlayerCc::MapProxy::GetCell" ref="ae0223523d460f6b6b470b2b30ffcd80c" args="(int x, int y) const " --> int8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classPlayerCc_1_1MapProxy.html#ae0223523d460f6b6b470b2b30ffcd80c">GetCell</a> (int x, int y) const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the (x,y) cell. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9e76ac2d52a8322bea2d7e3e5399a811"></a><!-- doxytag: member="PlayerCc::MapProxy::GetResolution" ref="a9e76ac2d52a8322bea2d7e3e5399a811" args="() const " --> double </td><td class="memItemRight" valign="bottom"><a class="el" href="classPlayerCc_1_1MapProxy.html#a9e76ac2d52a8322bea2d7e3e5399a811">GetResolution</a> () const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classMap.html">Map</a> resolution, m/cell. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classPlayerCc_1_1MapProxy.html#aea502c129ac15b0153d1fc3fef3d9ed8">GetWidth</a> () const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classMap.html">Map</a> size, in cells. <a href="#aea502c129ac15b0153d1fc3fef3d9ed8"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classPlayerCc_1_1MapProxy.html#ae06c0d904afbd34e154d7d72aa233f6c">GetHeight</a> () const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classMap.html">Map</a> size, in cells. <a href="#ae06c0d904afbd34e154d7d72aa233f6c"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a07fa495544279c73919cd54a364d88a8"></a><!-- doxytag: member="PlayerCc::MapProxy::GetOriginX" ref="a07fa495544279c73919cd54a364d88a8" args="() const " --> double </td><td class="memItemRight" valign="bottom"><b>GetOriginX</b> () const </td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6dd53e419f7d6c9fc3648da4e5e98b69"></a><!-- doxytag: member="PlayerCc::MapProxy::GetOriginY" ref="a6dd53e419f7d6c9fc3648da4e5e98b69" args="() const " --> double </td><td class="memItemRight" valign="bottom"><b>GetOriginY</b> () const </td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8f2617469f2d391a3d9f59373f11f5dc"></a><!-- doxytag: member="PlayerCc::MapProxy::GetMap" ref="a8f2617469f2d391a3d9f59373f11f5dc" args="(int8_t *aMap) const " --> void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPlayerCc_1_1MapProxy.html#a8f2617469f2d391a3d9f59373f11f5dc">GetMap</a> (int8_t *aMap) const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Occupancy for each cell (empty = -1, unknown = 0, occupied = +1). <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="a17c9e5d627ec3da345cb3e289571897c"></a><!-- doxytag: member="PlayerCc::MapProxy::Subscribe" ref="a17c9e5d627ec3da345cb3e289571897c" 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="a69f422c15eca235ed0bc97f30dcc77b6"></a><!-- doxytag: member="PlayerCc::MapProxy::Unsubscribe" ref="a69f422c15eca235ed0bc97f30dcc77b6" 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="a2dda825a6c1190afb9de0fa86804887b"></a><!-- doxytag: member="PlayerCc::MapProxy::mDevice" ref="a2dda825a6c1190afb9de0fa86804887b" args="" --> <a class="el" href="structplayerc__map__t.html">playerc_map_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>map</code> proxy provides access to a <a class="el" href="group__interface__map.html">map</a> device. </p> <hr/><h2>Member Function Documentation</h2> <a class="anchor" id="ae06c0d904afbd34e154d7d72aa233f6c"></a><!-- doxytag: member="PlayerCc::MapProxy::GetHeight" ref="ae06c0d904afbd34e154d7d72aa233f6c" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">uint32_t PlayerCc::MapProxy::GetHeight </td> <td>(</td> <td class="paramtype">void </td> <td class="paramname"></td> <td> ) </td> <td> const<code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p><a class="el" href="classMap.html">Map</a> size, in cells. </p> <dl class="todo"><dt><b><a class="el" href="todo.html#_todo000052">Todo:</a></b></dt><dd>should this be returned as a player_size_t? </dd></dl> </div> </div> <a class="anchor" id="aea502c129ac15b0153d1fc3fef3d9ed8"></a><!-- doxytag: member="PlayerCc::MapProxy::GetWidth" ref="aea502c129ac15b0153d1fc3fef3d9ed8" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">uint32_t PlayerCc::MapProxy::GetWidth </td> <td>(</td> <td class="paramtype">void </td> <td class="paramname"></td> <td> ) </td> <td> const<code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p><a class="el" href="classMap.html">Map</a> size, in cells. </p> <dl class="todo"><dt><b><a class="el" href="todo.html#_todo000051">Todo:</a></b></dt><dd>should this be returned as a player_size_t? </dd></dl> </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>