Sophie

Sophie

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

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="#pub-attribs">Public Attributes</a>  </div>
  <div class="headertitle">
<h1>player_simulation_property_req Struct Reference</h1>  </div>
</div>
<div class="contents">
<!-- doxytag: class="player_simulation_property_req" -->
<p>Request/reply: get/set a property of a named simulation object.  
<a href="#_details">More...</a></p>

<p><code>#include &lt;<a class="el" href="player__interfaces_8h_source.html">player_interfaces.h</a>&gt;</code></p>

<p><a href="structplayer__simulation__property__req-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"><a class="anchor" id="ae948baf40f5dddb237467ae77bdcda55"></a><!-- doxytag: member="player_simulation_property_req::name_count" ref="ae948baf40f5dddb237467ae77bdcda55" args="" -->
uint32_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structplayer__simulation__property__req.html#ae948baf40f5dddb237467ae77bdcda55">name_count</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Length of name. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aaaaf95f94d7ceca8d74e36a8e9644c0d"></a><!-- doxytag: member="player_simulation_property_req::name" ref="aaaaf95f94d7ceca8d74e36a8e9644c0d" args="" -->
char *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structplayer__simulation__property__req.html#aaaaf95f94d7ceca8d74e36a8e9644c0d">name</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The identifier of the object we want to locate. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab50caa631481ce486b5805410aaa11a0"></a><!-- doxytag: member="player_simulation_property_req::prop_count" ref="ab50caa631481ce486b5805410aaa11a0" args="" -->
uint32_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structplayer__simulation__property__req.html#ab50caa631481ce486b5805410aaa11a0">prop_count</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Length of property identifier. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a260152e4f96bf045eca86e97eb65a038"></a><!-- doxytag: member="player_simulation_property_req::prop" ref="a260152e4f96bf045eca86e97eb65a038" args="" -->
char *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structplayer__simulation__property__req.html#a260152e4f96bf045eca86e97eb65a038">prop</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The identifier of the property we want to get/set. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a762f8bb3fb7ebdef61ded0adebd844ba"></a><!-- doxytag: member="player_simulation_property_req::index" ref="a762f8bb3fb7ebdef61ded0adebd844ba" args="" -->
uint32_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structplayer__simulation__property__req.html#a762f8bb3fb7ebdef61ded0adebd844ba">index</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Index for properties with multiples values (arrays...). <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa9bf15c56c24bb9fb124a028c862c164"></a><!-- doxytag: member="player_simulation_property_req::value_count" ref="aa9bf15c56c24bb9fb124a028c862c164" args="" -->
uint32_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structplayer__simulation__property__req.html#aa9bf15c56c24bb9fb124a028c862c164">value_count</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The length of the value data in bytes. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab9707688d380436359569ef36d274dc3"></a><!-- doxytag: member="player_simulation_property_req::value" ref="ab9707688d380436359569ef36d274dc3" args="" -->
char *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structplayer__simulation__property__req.html#ab9707688d380436359569ef36d274dc3">value</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The value of the property. <br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Request/reply: get/set a property of a named simulation object. </p>
<dl class="user"><dt><b>To retrieve an property of an object in a simulator, send a </b></dt><dd>PLAYER_SIMULATION_REQ_GET_PROPERTY request. The server will reply with the value array filled in. The type of the data varies by property and it is up to the caller to cast the data to the correct type: see the warning below.</dd></dl>
<dl class="user"><dt><b>To set a property, send a completely filled in </b></dt><dd>PLAYER_SIMULATION_REQ_SET_PROPERTY request. The server will respond with an ACK if the property was successfully set to your value, else a NACK.</dd></dl>
<dl class="user"><dt><b>**WARNING** Types are architecture-dependent, so this feature may</b></dt><dd>not work correctly if the simulator is running on a different architecture than your client. The value bytes are transmitted as a raw binary object: no architecture-specific type conversions are performed. Use with caution. </dd></dl>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="player__interfaces_8h_source.html">player_interfaces.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>

Perl :: Catalyst :: PostgreSQL :: RPM Valid HTML 4.01 Transitional