Sophie

Sophie

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

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="header">
  <div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<h1>vectormap<br/>
<small>
[<a class="el" href="group__playerc__proxies.html">Device proxies</a>]</small>
</h1>  </div>
</div>
<div class="contents">

<p>The vectormap proxy provides an interface to a map of geometric features.  
<a href="#_details">More...</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structplayerc__vectormap__t.html">playerc_vectormap_t</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Vectormap proxy.  <a href="structplayerc__vectormap__t.html#_details">More...</a><br/></td></tr>
<tr><td colspan="2"><h2><a name="func-members"></a>
Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">PLAYERC_EXPORT <br class="typebreak"/>
<a class="el" href="structplayerc__vectormap__t.html">playerc_vectormap_t</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__playerc__proxy__vectormap.html#gaf8294682a4f5acdbd9137d48862fe858">playerc_vectormap_create</a> (<a class="el" href="struct__playerc__client__t.html">playerc_client_t</a> *client, int index)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Create a vectormap proxy.  <a href="#gaf8294682a4f5acdbd9137d48862fe858"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">PLAYERC_EXPORT void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__playerc__proxy__vectormap.html#ga91fb4e81642139f2f631ad8b75ed46d5">playerc_vectormap_destroy</a> (<a class="el" href="structplayerc__vectormap__t.html">playerc_vectormap_t</a> *device)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Destroy a vectormap proxy.  <a href="#ga91fb4e81642139f2f631ad8b75ed46d5"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">PLAYERC_EXPORT int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__playerc__proxy__vectormap.html#ga566baef814afa39e49cb62cc87731354">playerc_vectormap_subscribe</a> (<a class="el" href="structplayerc__vectormap__t.html">playerc_vectormap_t</a> *device, int access)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Subscribe to the vectormap device.  <a href="#ga566baef814afa39e49cb62cc87731354"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">PLAYERC_EXPORT int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__playerc__proxy__vectormap.html#ga4ce2877be16bff7eae41859f293e58c8">playerc_vectormap_unsubscribe</a> (<a class="el" href="structplayerc__vectormap__t.html">playerc_vectormap_t</a> *device)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Un-subscribe from the vectormap device.  <a href="#ga4ce2877be16bff7eae41859f293e58c8"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">PLAYERC_EXPORT int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__playerc__proxy__vectormap.html#ga64fe99edbcec8c19ff8a962cb8d30f44">playerc_vectormap_get_map_info</a> (<a class="el" href="structplayerc__vectormap__t.html">playerc_vectormap_t</a> *device)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the vectormap metadata, which is stored in the proxy.  <a href="#ga64fe99edbcec8c19ff8a962cb8d30f44"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">PLAYERC_EXPORT int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__playerc__proxy__vectormap.html#ga692425597ca95a13b7f8e795639bc4f2">playerc_vectormap_get_layer_data</a> (<a class="el" href="structplayerc__vectormap__t.html">playerc_vectormap_t</a> *device, unsigned layer_index)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the layer data by index.  <a href="#ga692425597ca95a13b7f8e795639bc4f2"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">PLAYERC_EXPORT int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__playerc__proxy__vectormap.html#gae2411e5fc096134d70d072139b4daab1">playerc_vectormap_write_layer</a> (<a class="el" href="structplayerc__vectormap__t.html">playerc_vectormap_t</a> *device, const <a class="el" href="structplayer__vectormap__layer__data.html">player_vectormap_layer_data_t</a> *data)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Write layer data.  <a href="#gae2411e5fc096134d70d072139b4daab1"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">PLAYERC_EXPORT void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__playerc__proxy__vectormap.html#gaa882eef56780649b5d38c59699a519c0">playerc_vectormap_cleanup</a> (<a class="el" href="structplayerc__vectormap__t.html">playerc_vectormap_t</a> *device)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Clean up the dynamically allocated memory for the vectormap.  <a href="#gaa882eef56780649b5d38c59699a519c0"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">PLAYERC_EXPORT uint8_t *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__playerc__proxy__vectormap.html#ga702f6498d1f3110bab7d321271a03dd2">playerc_vectormap_get_feature_data</a> (<a class="el" href="structplayerc__vectormap__t.html">playerc_vectormap_t</a> *device, unsigned layer_index, unsigned feature_index)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get an individual feature as a WKB geometry.  <a href="#ga702f6498d1f3110bab7d321271a03dd2"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gadb2c377afc4d32bf1f0e80429e3b4678"></a><!-- doxytag: member="playerc_proxy_vectormap::playerc_vectormap_get_feature_data_count" ref="gadb2c377afc4d32bf1f0e80429e3b4678" args="(playerc_vectormap_t *device, unsigned layer_index, unsigned feature_index)" -->
PLAYERC_EXPORT size_t&nbsp;</td><td class="memItemRight" valign="bottom"><b>playerc_vectormap_get_feature_data_count</b> (<a class="el" href="structplayerc__vectormap__t.html">playerc_vectormap_t</a> *device, unsigned layer_index, unsigned feature_index)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>The vectormap proxy provides an interface to a map of geometric features. </p>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="gaa882eef56780649b5d38c59699a519c0"></a><!-- doxytag: member="playerc.h::playerc_vectormap_cleanup" ref="gaa882eef56780649b5d38c59699a519c0" args="(playerc_vectormap_t *device)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">PLAYERC_EXPORT void playerc_vectormap_cleanup </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structplayerc__vectormap__t.html">playerc_vectormap_t</a> *&nbsp;</td>
          <td class="paramname"> <em>device</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Clean up the dynamically allocated memory for the vectormap. </p>

</div>
</div>
<a class="anchor" id="gaf8294682a4f5acdbd9137d48862fe858"></a><!-- doxytag: member="playerc.h::playerc_vectormap_create" ref="gaf8294682a4f5acdbd9137d48862fe858" args="(playerc_client_t *client, int index)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">PLAYERC_EXPORT <a class="el" href="structplayerc__vectormap__t.html">playerc_vectormap_t</a>* playerc_vectormap_create </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct__playerc__client__t.html">playerc_client_t</a> *&nbsp;</td>
          <td class="paramname"> <em>client</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>index</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Create a vectormap proxy. </p>

</div>
</div>
<a class="anchor" id="ga91fb4e81642139f2f631ad8b75ed46d5"></a><!-- doxytag: member="playerc.h::playerc_vectormap_destroy" ref="ga91fb4e81642139f2f631ad8b75ed46d5" args="(playerc_vectormap_t *device)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">PLAYERC_EXPORT void playerc_vectormap_destroy </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structplayerc__vectormap__t.html">playerc_vectormap_t</a> *&nbsp;</td>
          <td class="paramname"> <em>device</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Destroy a vectormap proxy. </p>

</div>
</div>
<a class="anchor" id="ga702f6498d1f3110bab7d321271a03dd2"></a><!-- doxytag: member="playerc.h::playerc_vectormap_get_feature_data" ref="ga702f6498d1f3110bab7d321271a03dd2" args="(playerc_vectormap_t *device, unsigned layer_index, unsigned feature_index)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">PLAYERC_EXPORT uint8_t* playerc_vectormap_get_feature_data </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structplayerc__vectormap__t.html">playerc_vectormap_t</a> *&nbsp;</td>
          <td class="paramname"> <em>device</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">unsigned&nbsp;</td>
          <td class="paramname"> <em>layer_index</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">unsigned&nbsp;</td>
          <td class="paramname"> <em>feature_index</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Get an individual feature as a WKB geometry. </p>
<p>Must only be used after a successful call to playerc_vectormap_get_layer_data. The WKB geometry is owned by the proxy, duplicate it if it is needed after the next call to get_feature_data. </p>

</div>
</div>
<a class="anchor" id="ga692425597ca95a13b7f8e795639bc4f2"></a><!-- doxytag: member="playerc.h::playerc_vectormap_get_layer_data" ref="ga692425597ca95a13b7f8e795639bc4f2" args="(playerc_vectormap_t *device, unsigned layer_index)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">PLAYERC_EXPORT int playerc_vectormap_get_layer_data </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structplayerc__vectormap__t.html">playerc_vectormap_t</a> *&nbsp;</td>
          <td class="paramname"> <em>device</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">unsigned&nbsp;</td>
          <td class="paramname"> <em>layer_index</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Get the layer data by index. </p>
<p>Must only be used after a successfull call to playerc_vectormap_get_map_info. </p>

</div>
</div>
<a class="anchor" id="ga64fe99edbcec8c19ff8a962cb8d30f44"></a><!-- doxytag: member="playerc.h::playerc_vectormap_get_map_info" ref="ga64fe99edbcec8c19ff8a962cb8d30f44" args="(playerc_vectormap_t *device)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">PLAYERC_EXPORT int playerc_vectormap_get_map_info </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structplayerc__vectormap__t.html">playerc_vectormap_t</a> *&nbsp;</td>
          <td class="paramname"> <em>device</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Get the vectormap metadata, which is stored in the proxy. </p>

</div>
</div>
<a class="anchor" id="ga566baef814afa39e49cb62cc87731354"></a><!-- doxytag: member="playerc.h::playerc_vectormap_subscribe" ref="ga566baef814afa39e49cb62cc87731354" args="(playerc_vectormap_t *device, int access)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">PLAYERC_EXPORT int playerc_vectormap_subscribe </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structplayerc__vectormap__t.html">playerc_vectormap_t</a> *&nbsp;</td>
          <td class="paramname"> <em>device</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>access</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Subscribe to the vectormap device. </p>

</div>
</div>
<a class="anchor" id="ga4ce2877be16bff7eae41859f293e58c8"></a><!-- doxytag: member="playerc.h::playerc_vectormap_unsubscribe" ref="ga4ce2877be16bff7eae41859f293e58c8" args="(playerc_vectormap_t *device)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">PLAYERC_EXPORT int playerc_vectormap_unsubscribe </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structplayerc__vectormap__t.html">playerc_vectormap_t</a> *&nbsp;</td>
          <td class="paramname"> <em>device</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Un-subscribe from the vectormap device. </p>

</div>
</div>
<a class="anchor" id="gae2411e5fc096134d70d072139b4daab1"></a><!-- doxytag: member="playerc.h::playerc_vectormap_write_layer" ref="gae2411e5fc096134d70d072139b4daab1" args="(playerc_vectormap_t *device, const player_vectormap_layer_data_t *data)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">PLAYERC_EXPORT int playerc_vectormap_write_layer </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structplayerc__vectormap__t.html">playerc_vectormap_t</a> *&nbsp;</td>
          <td class="paramname"> <em>device</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="structplayer__vectormap__layer__data.html">player_vectormap_layer_data_t</a> *&nbsp;</td>
          <td class="paramname"> <em>data</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Write layer data. </p>

</div>
</div>
</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