Sophie

Sophie

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

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-methods">Public Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a>  </div>
  <div class="headertitle">
<h1>Property Class Reference</h1>  </div>
</div>
<div class="contents">
<!-- doxytag: class="Property" -->
<p><a class="el" href="classProperty.html" title="Property base class.">Property</a> base class.  
<a href="#_details">More...</a></p>

<p><code>#include &lt;<a class="el" href="property_8h_source.html">property.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for Property:</div>
<div class="dyncontent">
 <div class="center">
  <img src="classProperty.png" usemap="#Property_map" alt=""/>
  <map id="Property_map" name="Property_map">
<area href="classBoolProperty.html" alt="BoolProperty" shape="rect" coords="0,56,101,80"/>
<area href="classDoubleProperty.html" alt="DoubleProperty" shape="rect" coords="111,56,212,80"/>
<area href="classIntProperty.html" alt="IntProperty" shape="rect" coords="222,56,323,80"/>
<area href="classStringProperty.html" alt="StringProperty" shape="rect" coords="333,56,434,80"/>
</map>
</div>

<p><a href="classProperty-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="ae8736392555be5a0b66648af7d49f82c"></a><!-- doxytag: member="Property::Property" ref="ae8736392555be5a0b66648af7d49f82c" args="(const char *newKey, bool readOnly)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><b>Property</b> (const char *newKey, bool readOnly)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a068b5c4b55b1265ae10742b1d09f1ccd"></a><!-- doxytag: member="Property::GetKey" ref="a068b5c4b55b1265ae10742b1d09f1ccd" args="(void) const " -->
virtual const char *&nbsp;</td><td class="memItemRight" valign="bottom"><b>GetKey</b> (void) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a199706094ab3e7d1d78efeda12808bfa"></a><!-- doxytag: member="Property::SetKey" ref="a199706094ab3e7d1d78efeda12808bfa" args="(const char *newKey)" -->
virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><b>SetKey</b> (const char *newKey)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa41eaee138f52dd1019da7d17644e771"></a><!-- doxytag: member="Property::GetValueToMessage" ref="aa41eaee138f52dd1019da7d17644e771" args="(void *data) const =0" -->
virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><b>GetValueToMessage</b> (void *data) const =0</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1b12521c9017ed63f8a5b39cb0d87aa5"></a><!-- doxytag: member="Property::SetValueFromMessage" ref="a1b12521c9017ed63f8a5b39cb0d87aa5" args="(const void *data)=0" -->
virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><b>SetValueFromMessage</b> (const void *data)=0</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a54442723626846c303dd4de8f88b3d9f"></a><!-- doxytag: member="Property::KeyIsEqual" ref="a54442723626846c303dd4de8f88b3d9f" args="(const char *rhs)" -->
virtual const bool&nbsp;</td><td class="memItemRight" valign="bottom"><b>KeyIsEqual</b> (const char *rhs)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af632ae49a72a7401ddc1f93b2aaaac31"></a><!-- doxytag: member="Property::ReadConfig" ref="af632ae49a72a7401ddc1f93b2aaaac31" args="(ConfigFile *cf, int section)=0" -->
virtual bool&nbsp;</td><td class="memItemRight" valign="bottom"><b>ReadConfig</b> (<a class="el" href="classConfigFile.html">ConfigFile</a> *cf, int section)=0</td></tr>
<tr><td colspan="2"><h2><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a99c8a43f493d45e12801b03903e71d3f"></a><!-- doxytag: member="Property::key" ref="a99c8a43f493d45e12801b03903e71d3f" args="" -->
char *&nbsp;</td><td class="memItemRight" valign="bottom"><b>key</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9bc27536c05eb06196faece5909084f7"></a><!-- doxytag: member="Property::readonly" ref="a9bc27536c05eb06196faece5909084f7" args="" -->
bool&nbsp;</td><td class="memItemRight" valign="bottom"><b>readonly</b></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p><a class="el" href="classProperty.html" title="Property base class.">Property</a> base class. </p>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="property_8h_source.html">property.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>