<!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="header">
<div class="summary">
<a href="#pub-attribs">Public Attributes</a> </div>
<div class="headertitle">
<h1>_playerc_device_t Struct Reference<br/>
<small>
[<a class="el" href="group__playerc__device.html">Device API</a>]</small>
</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="_playerc_device_t" -->
<p>Common device info.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="playerc_8h_source.html">playerc.h</a>></code></p>
<p><a href="struct__playerc__device__t-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__playerc__device__t.html#adc7b9a1af67df7473563ca5ab1b358b3">id</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A useful ID for identifying devices; mostly used by other language bindings. <a href="#adc7b9a1af67df7473563ca5ab1b358b3"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct__playerc__client__t.html">playerc_client_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__playerc__device__t.html#a278782fe8308fa8abdc9bdc31ce82afe">client</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Pointer to the client proxy. <a href="#a278782fe8308fa8abdc9bdc31ce82afe"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af8fe41fa301ca029aaeabb3aaba0700e"></a><!-- doxytag: member="_playerc_device_t::addr" ref="af8fe41fa301ca029aaeabb3aaba0700e" args="" -->
<a class="el" href="structplayer__devaddr.html">player_devaddr_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__playerc__device__t.html#af8fe41fa301ca029aaeabb3aaba0700e">addr</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classDevice.html" title="Encapsulates a device (i.e., a driver bound to an interface).">Device</a> address. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">char </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__playerc__device__t.html#a88a140f829940c3b998187e67d692fa3">drivername</a> [PLAYER_MAX_DRIVER_STRING_LEN]</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The driver name. <a href="#a88a140f829940c3b998187e67d692fa3"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__playerc__device__t.html#a470cb706a9e6cda107d1a9d5923ff3da">subscribed</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The subscribe flag is non-zero if the device has been successfully subscribed (read-only). <a href="#a470cb706a9e6cda107d1a9d5923ff3da"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__playerc__device__t.html#aea0697bbfff54b4be428ed4f6755c8ff">datatime</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Data timestamp, i.e., the time at which the data was generated (s). <a href="#aea0697bbfff54b4be428ed4f6755c8ff"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__playerc__device__t.html#a26306b621f9ca53f4bebcc02c2de44ef">lasttime</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Data timestamp from the previous data. <a href="#a26306b621f9ca53f4bebcc02c2de44ef"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__playerc__device__t.html#a2672b913eb157d3098487c7186d37543">fresh</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Freshness flag. <a href="#a2672b913eb157d3098487c7186d37543"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__playerc__device__t.html#ae2753e0c0826e8db8306050727e96f3e">freshgeom</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Freshness flag. <a href="#ae2753e0c0826e8db8306050727e96f3e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__playerc__device__t.html#a53c87b27a061f66adc1e2762cfd4959a">freshconfig</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Freshness flag. <a href="#a53c87b27a061f66adc1e2762cfd4959a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__playerc__client.html#gad98282e0bb4b776229284c0342c6f348">playerc_putmsg_fn_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__playerc__device__t.html#abc905b9026968820209dfbf4e624f6cc">putmsg</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Standard message callback for this device. <a href="#abc905b9026968820209dfbf4e624f6cc"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__playerc__device__t.html#ae2193d62f96d79ea248beffc96fad81f">user_data</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Extra user data for this device. <a href="#ae2193d62f96d79ea248beffc96fad81f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__playerc__device__t.html#aec94c56d51ba705ca5828eb5b4dea10a">callback_count</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Extra callbacks for this device. <a href="#aec94c56d51ba705ca5828eb5b4dea10a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af37662cba428016810f399a34219654f"></a><!-- doxytag: member="_playerc_device_t::callback" ref="af37662cba428016810f399a34219654f" args="[4]" -->
<a class="el" href="group__playerc__client.html#gad7e70480b0d4c9f57dbe980a6a4293eb">playerc_callback_fn_t</a> </td><td class="memItemRight" valign="bottom"><b>callback</b> [4]</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aee950a15abeef5b9d3450cca6181011f"></a><!-- doxytag: member="_playerc_device_t::callback_data" ref="aee950a15abeef5b9d3450cca6181011f" args="[4]" -->
void * </td><td class="memItemRight" valign="bottom"><b>callback_data</b> [4]</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Common device info. </p>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="aec94c56d51ba705ca5828eb5b4dea10a"></a><!-- doxytag: member="_playerc_device_t::callback_count" ref="aec94c56d51ba705ca5828eb5b4dea10a" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="struct__playerc__device__t.html#aec94c56d51ba705ca5828eb5b4dea10a">_playerc_device_t::callback_count</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Extra callbacks for this device. </p>
<p><b>For internal use only.</b></p>
</div>
</div>
<a class="anchor" id="a278782fe8308fa8abdc9bdc31ce82afe"></a><!-- doxytag: member="_playerc_device_t::client" ref="a278782fe8308fa8abdc9bdc31ce82afe" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="struct__playerc__client__t.html">playerc_client_t</a>* <a class="el" href="struct__playerc__device__t.html#a278782fe8308fa8abdc9bdc31ce82afe">_playerc_device_t::client</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Pointer to the client proxy. </p>
</div>
</div>
<a class="anchor" id="aea0697bbfff54b4be428ed4f6755c8ff"></a><!-- doxytag: member="_playerc_device_t::datatime" ref="aea0697bbfff54b4be428ed4f6755c8ff" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double <a class="el" href="struct__playerc__device__t.html#aea0697bbfff54b4be428ed4f6755c8ff">_playerc_device_t::datatime</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Data timestamp, i.e., the time at which the data was generated (s). </p>
</div>
</div>
<a class="anchor" id="a88a140f829940c3b998187e67d692fa3"></a><!-- doxytag: member="_playerc_device_t::drivername" ref="a88a140f829940c3b998187e67d692fa3" args="[PLAYER_MAX_DRIVER_STRING_LEN]" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char <a class="el" href="struct__playerc__device__t.html#a88a140f829940c3b998187e67d692fa3">_playerc_device_t::drivername</a>[PLAYER_MAX_DRIVER_STRING_LEN]</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The driver name. </p>
</div>
</div>
<a class="anchor" id="a2672b913eb157d3098487c7186d37543"></a><!-- doxytag: member="_playerc_device_t::fresh" ref="a2672b913eb157d3098487c7186d37543" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="struct__playerc__device__t.html#a2672b913eb157d3098487c7186d37543">_playerc_device_t::fresh</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Freshness flag. </p>
<p>Set to 1 whenever data is dispatched to this proxy. Useful with the multi-client, but the user must manually set it to 0 after using the data. </p>
</div>
</div>
<a class="anchor" id="a53c87b27a061f66adc1e2762cfd4959a"></a><!-- doxytag: member="_playerc_device_t::freshconfig" ref="a53c87b27a061f66adc1e2762cfd4959a" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="struct__playerc__device__t.html#a53c87b27a061f66adc1e2762cfd4959a">_playerc_device_t::freshconfig</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Freshness flag. </p>
<p>Set to 1 whenever data is dispatched to this proxy. Useful with the multi-client, but the user must manually set it to 0 after using the data. </p>
</div>
</div>
<a class="anchor" id="ae2753e0c0826e8db8306050727e96f3e"></a><!-- doxytag: member="_playerc_device_t::freshgeom" ref="ae2753e0c0826e8db8306050727e96f3e" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="struct__playerc__device__t.html#ae2753e0c0826e8db8306050727e96f3e">_playerc_device_t::freshgeom</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Freshness flag. </p>
<p>Set to 1 whenever data is dispatched to this proxy. Useful with the multi-client, but the user must manually set it to 0 after using the data. </p>
</div>
</div>
<a class="anchor" id="adc7b9a1af67df7473563ca5ab1b358b3"></a><!-- doxytag: member="_playerc_device_t::id" ref="adc7b9a1af67df7473563ca5ab1b358b3" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void* <a class="el" href="struct__playerc__device__t.html#adc7b9a1af67df7473563ca5ab1b358b3">_playerc_device_t::id</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>A useful ID for identifying devices; mostly used by other language bindings. </p>
<p>For backwards-compatibility, this is passed as void pointer. </p>
</div>
</div>
<a class="anchor" id="a26306b621f9ca53f4bebcc02c2de44ef"></a><!-- doxytag: member="_playerc_device_t::lasttime" ref="a26306b621f9ca53f4bebcc02c2de44ef" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double <a class="el" href="struct__playerc__device__t.html#a26306b621f9ca53f4bebcc02c2de44ef">_playerc_device_t::lasttime</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Data timestamp from the previous data. </p>
</div>
</div>
<a class="anchor" id="abc905b9026968820209dfbf4e624f6cc"></a><!-- doxytag: member="_playerc_device_t::putmsg" ref="abc905b9026968820209dfbf4e624f6cc" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__playerc__client.html#gad98282e0bb4b776229284c0342c6f348">playerc_putmsg_fn_t</a> <a class="el" href="struct__playerc__device__t.html#abc905b9026968820209dfbf4e624f6cc">_playerc_device_t::putmsg</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Standard message callback for this device. </p>
<p><b>For internal use only.</b></p>
</div>
</div>
<a class="anchor" id="a470cb706a9e6cda107d1a9d5923ff3da"></a><!-- doxytag: member="_playerc_device_t::subscribed" ref="a470cb706a9e6cda107d1a9d5923ff3da" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="struct__playerc__device__t.html#a470cb706a9e6cda107d1a9d5923ff3da">_playerc_device_t::subscribed</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The subscribe flag is non-zero if the device has been successfully subscribed (read-only). </p>
</div>
</div>
<a class="anchor" id="ae2193d62f96d79ea248beffc96fad81f"></a><!-- doxytag: member="_playerc_device_t::user_data" ref="ae2193d62f96d79ea248beffc96fad81f" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void* <a class="el" href="struct__playerc__device__t.html#ae2193d62f96d79ea248beffc96fad81f">_playerc_device_t::user_data</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Extra user data for this device. </p>
<p><b>For internal use only.</b></p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="playerc_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
>
1070
