Sophie

Sophie

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

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="headertitle">
<h1>property.h</h1>  </div>
</div>
<div class="contents">
<div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span>
<a name="l00002"></a>00002 <span class="comment"> *  Player - One Hell of a Robot Server</span>
<a name="l00003"></a>00003 <span class="comment"> *  Copyright (C) 2000</span>
<a name="l00004"></a>00004 <span class="comment"> *     Brian Gerkey, Kasper Stoy, Richard Vaughan, &amp; Andrew Howard</span>
<a name="l00005"></a>00005 <span class="comment"> *</span>
<a name="l00006"></a>00006 <span class="comment"> *</span>
<a name="l00007"></a>00007 <span class="comment"> *  This program is free software; you can redistribute it and/or modify</span>
<a name="l00008"></a>00008 <span class="comment"> *  it under the terms of the GNU General Public License as published by</span>
<a name="l00009"></a>00009 <span class="comment"> *  the Free Software Foundation; either version 2 of the License, or</span>
<a name="l00010"></a>00010 <span class="comment"> *  (at your option) any later version.</span>
<a name="l00011"></a>00011 <span class="comment"> *</span>
<a name="l00012"></a>00012 <span class="comment"> *  This program is distributed in the hope that it will be useful,</span>
<a name="l00013"></a>00013 <span class="comment"> *  but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00014"></a>00014 <span class="comment"> *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the</span>
<a name="l00015"></a>00015 <span class="comment"> *  GNU General Public License for more details.</span>
<a name="l00016"></a>00016 <span class="comment"> *</span>
<a name="l00017"></a>00017 <span class="comment"> *  You should have received a copy of the GNU General Public License</span>
<a name="l00018"></a>00018 <span class="comment"> *  along with this program; if not, write to the Free Software</span>
<a name="l00019"></a>00019 <span class="comment"> *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA</span>
<a name="l00020"></a>00020 <span class="comment"> *</span>
<a name="l00021"></a>00021 <span class="comment"> */</span>
<a name="l00022"></a>00022 <span class="comment">/********************************************************************</span>
<a name="l00023"></a>00023 <span class="comment"> *</span>
<a name="l00024"></a>00024 <span class="comment"> *  This library is free software; you can redistribute it and/or</span>
<a name="l00025"></a>00025 <span class="comment"> *  modify it under the terms of the GNU Lesser General Public</span>
<a name="l00026"></a>00026 <span class="comment"> *  License as published by the Free Software Foundation; either</span>
<a name="l00027"></a>00027 <span class="comment"> *  version 2.1 of the License, or (at your option) any later version.</span>
<a name="l00028"></a>00028 <span class="comment"> *</span>
<a name="l00029"></a>00029 <span class="comment"> *  This library is distributed in the hope that it will be useful,</span>
<a name="l00030"></a>00030 <span class="comment"> *  but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00031"></a>00031 <span class="comment"> *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU</span>
<a name="l00032"></a>00032 <span class="comment"> *  Lesser General Public License for more details.</span>
<a name="l00033"></a>00033 <span class="comment"> *</span>
<a name="l00034"></a>00034 <span class="comment"> *  You should have received a copy of the GNU Lesser General Public</span>
<a name="l00035"></a>00035 <span class="comment"> *  License along with this library; if not, write to the Free Software</span>
<a name="l00036"></a>00036 <span class="comment"> *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA</span>
<a name="l00037"></a>00037 <span class="comment"> *</span>
<a name="l00038"></a>00038 <span class="comment"> ********************************************************************/</span>
<a name="l00039"></a>00039 
<a name="l00040"></a>00040 <span class="preprocessor">#ifndef __PROPERTY_H</span>
<a name="l00041"></a>00041 <span class="preprocessor"></span><span class="preprocessor">#define __PROPERTY_H</span>
<a name="l00042"></a>00042 <span class="preprocessor"></span>
<a name="l00043"></a>00043 <span class="preprocessor">#if defined (WIN32)</span>
<a name="l00044"></a>00044 <span class="preprocessor"></span><span class="preprocessor">  #if defined (PLAYER_STATIC)</span>
<a name="l00045"></a>00045 <span class="preprocessor"></span><span class="preprocessor">    #define PLAYERCORE_EXPORT</span>
<a name="l00046"></a>00046 <span class="preprocessor"></span><span class="preprocessor">  #elif defined (playercore_EXPORTS)</span>
<a name="l00047"></a>00047 <span class="preprocessor"></span><span class="preprocessor">    #define PLAYERCORE_EXPORT    __declspec (dllexport)</span>
<a name="l00048"></a>00048 <span class="preprocessor"></span><span class="preprocessor">  #else</span>
<a name="l00049"></a>00049 <span class="preprocessor"></span><span class="preprocessor">    #define PLAYERCORE_EXPORT    __declspec (dllimport)</span>
<a name="l00050"></a>00050 <span class="preprocessor"></span><span class="preprocessor">  #endif</span>
<a name="l00051"></a>00051 <span class="preprocessor"></span><span class="preprocessor">#else</span>
<a name="l00052"></a>00052 <span class="preprocessor"></span><span class="preprocessor">  #define PLAYERCORE_EXPORT</span>
<a name="l00053"></a>00053 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
<a name="l00054"></a>00054 <span class="preprocessor"></span>
<a name="l00055"></a>00055 <span class="keyword">class </span><a class="code" href="classConfigFile.html" title="Class for loading configuration file information.">ConfigFile</a>;
<a name="l00056"></a>00056 <span class="keyword">class </span><a class="code" href="classDriver.html" title="Base class for all drivers.">Driver</a>;
<a name="l00057"></a>00057 
<a name="l00059"></a><a class="code" href="classProperty.html">00059</a> <span class="keyword">class </span>PLAYERCORE_EXPORT <a class="code" href="classProperty.html" title="Property base class.">Property</a>
<a name="l00060"></a>00060 {
<a name="l00061"></a>00061         <span class="keyword">public</span>:
<a name="l00062"></a>00062                 <a class="code" href="classProperty.html" title="Property base class.">Property</a> (<span class="keywordtype">void</span>);
<a name="l00063"></a>00063                 <a class="code" href="classProperty.html" title="Property base class.">Property</a> (<span class="keyword">const</span> <span class="keywordtype">char</span> *newKey, <span class="keywordtype">bool</span> readOnly);
<a name="l00064"></a>00064                 <span class="keyword">virtual</span> ~<a class="code" href="classProperty.html" title="Property base class.">Property</a> (<span class="keywordtype">void</span>);
<a name="l00065"></a>00065 
<a name="l00066"></a>00066                 <span class="comment">// Accessor functions</span>
<a name="l00067"></a>00067                 <span class="keyword">virtual</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* GetKey (<span class="keywordtype">void</span>)<span class="keyword"> const         </span>{ <span class="keywordflow">return</span> key; }
<a name="l00068"></a>00068                 <span class="keyword">virtual</span> <span class="keywordtype">void</span> SetKey (<span class="keyword">const</span> <span class="keywordtype">char</span> *newKey);
<a name="l00069"></a>00069                 <span class="keyword">virtual</span> <span class="keywordtype">void</span> GetValueToMessage (<span class="keywordtype">void</span> *data) <span class="keyword">const</span> = 0;
<a name="l00070"></a>00070                 <span class="keyword">virtual</span> <span class="keywordtype">void</span> SetValueFromMessage (<span class="keyword">const</span> <span class="keywordtype">void</span> *data) = 0;
<a name="l00071"></a>00071 
<a name="l00072"></a>00072                 <span class="keyword">virtual</span> <span class="keyword">const</span> <span class="keywordtype">bool</span> KeyIsEqual (<span class="keyword">const</span> <span class="keywordtype">char</span> *rhs);
<a name="l00073"></a>00073 
<a name="l00074"></a>00074                 <span class="comment">// Config file read method</span>
<a name="l00075"></a>00075                 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> ReadConfig (<a class="code" href="classConfigFile.html" title="Class for loading configuration file information.">ConfigFile</a> *cf, <span class="keywordtype">int</span> section) = 0;
<a name="l00076"></a>00076 
<a name="l00077"></a>00077         <span class="keyword">protected</span>:
<a name="l00078"></a>00078                 <span class="keywordtype">char</span> *key;                      <span class="comment">// Key for this property</span>
<a name="l00079"></a>00079                 <span class="keywordtype">bool</span> readonly;          <span class="comment">// true if this property is read-only</span>
<a name="l00080"></a>00080 };
<a name="l00081"></a>00081 
<a name="l00084"></a>00084 
<a name="l00086"></a><a class="code" href="classBoolProperty.html">00086</a> <span class="keyword">class </span>PLAYERCORE_EXPORT <a class="code" href="classBoolProperty.html" title="Boolean property class.">BoolProperty</a> : <span class="keyword">public</span> <a class="code" href="classProperty.html" title="Property base class.">Property</a>
<a name="l00087"></a>00087 {
<a name="l00088"></a>00088         <span class="keyword">public</span>:
<a name="l00089"></a>00089                 <a class="code" href="classBoolProperty.html" title="Boolean property class.">BoolProperty</a> (<span class="keyword">const</span> <span class="keywordtype">char</span> *newKey, <span class="keywordtype">bool</span> newValue, <span class="keywordtype">bool</span> readOnly);
<a name="l00091"></a>00091                 <a class="code" href="classBoolProperty.html" title="Boolean property class.">BoolProperty</a> (<span class="keyword">const</span> <span class="keywordtype">char</span> *newKey, <span class="keywordtype">bool</span> newValue, <span class="keywordtype">bool</span> readOnly, <a class="code" href="classDriver.html" title="Base class for all drivers.">Driver</a> * driver, <a class="code" href="classConfigFile.html" title="Class for loading configuration file information.">ConfigFile</a>*cf, <span class="keywordtype">int</span> section);
<a name="l00092"></a>00092 
<a name="l00093"></a>00093                 <span class="keywordtype">bool</span> GetValue (<span class="keywordtype">void</span>)<span class="keyword"> const              </span>{ <span class="keywordflow">return</span> value; }
<a name="l00094"></a>00094                 <span class="keywordtype">void</span> SetValue (<span class="keywordtype">bool</span> newValue);
<a name="l00095"></a>00095                 <span class="keywordtype">void</span> GetValueToMessage (<span class="keywordtype">void</span> *data) <span class="keyword">const</span>;
<a name="l00096"></a>00096                 <span class="keywordtype">void</span> SetValueFromMessage (<span class="keyword">const</span> <span class="keywordtype">void</span> *data);
<a name="l00097"></a>00097 
<a name="l00098"></a>00098                 <span class="comment">// Config file read method</span>
<a name="l00099"></a>00099                 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> ReadConfig (<a class="code" href="classConfigFile.html" title="Class for loading configuration file information.">ConfigFile</a> *cf, <span class="keywordtype">int</span> section);
<a name="l00100"></a>00100 
<a name="l00101"></a>00101                 <span class="comment">// Operators</span>
<a name="l00102"></a>00102                 operator bool (<span class="keywordtype">void</span>)                    { <span class="keywordflow">return</span> value; }
<a name="l00103"></a>00103                 <span class="keyword">const</span> <a class="code" href="classBoolProperty.html" title="Boolean property class.">BoolProperty</a>&amp; operator= (<span class="keyword">const</span> <a class="code" href="classBoolProperty.html" title="Boolean property class.">BoolProperty</a> &amp;rhs);
<a name="l00104"></a>00104                 <span class="keywordtype">bool</span> operator= (<span class="keywordtype">bool</span> rhs);
<a name="l00105"></a>00105 
<a name="l00106"></a>00106         <span class="keyword">private</span>:
<a name="l00107"></a>00107                 <span class="keywordtype">bool</span> value;
<a name="l00108"></a>00108 };
<a name="l00109"></a>00109 
<a name="l00112"></a>00112 
<a name="l00114"></a><a class="code" href="classIntProperty.html">00114</a> <span class="keyword">class </span>PLAYERCORE_EXPORT <a class="code" href="classIntProperty.html" title="Integer property class.">IntProperty</a> : <span class="keyword">public</span> <a class="code" href="classProperty.html" title="Property base class.">Property</a>
<a name="l00115"></a>00115 {
<a name="l00116"></a>00116         <span class="keyword">public</span>:
<a name="l00117"></a>00117                 <a class="code" href="classIntProperty.html" title="Integer property class.">IntProperty</a> (<span class="keyword">const</span> <span class="keywordtype">char</span> *newKey, <span class="keywordtype">int</span> newValue, <span class="keywordtype">bool</span> readOnly);
<a name="l00119"></a>00119                 <a class="code" href="classIntProperty.html" title="Integer property class.">IntProperty</a> (<span class="keyword">const</span> <span class="keywordtype">char</span> *newKey, <span class="keywordtype">int</span> newValue, <span class="keywordtype">bool</span> readOnly, <a class="code" href="classDriver.html" title="Base class for all drivers.">Driver</a> * driver, <a class="code" href="classConfigFile.html" title="Class for loading configuration file information.">ConfigFile</a>*cf, <span class="keywordtype">int</span> section);
<a name="l00120"></a>00120 
<a name="l00121"></a>00121                 <span class="keywordtype">int</span> GetValue (<span class="keywordtype">void</span>)<span class="keyword"> const                       </span>{ <span class="keywordflow">return</span> value; }
<a name="l00122"></a>00122                 <span class="keywordtype">void</span> SetValue (<span class="keywordtype">int</span> newValue);
<a name="l00123"></a>00123                 <span class="keywordtype">void</span> GetValueToMessage (<span class="keywordtype">void</span> *data) <span class="keyword">const</span>;
<a name="l00124"></a>00124                 <span class="keywordtype">void</span> SetValueFromMessage (<span class="keyword">const</span> <span class="keywordtype">void</span> *data);
<a name="l00125"></a>00125 
<a name="l00126"></a>00126                 <span class="comment">// Config file read method</span>
<a name="l00127"></a>00127                 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> ReadConfig (<a class="code" href="classConfigFile.html" title="Class for loading configuration file information.">ConfigFile</a> *cf, <span class="keywordtype">int</span> section);
<a name="l00128"></a>00128 
<a name="l00129"></a>00129                 <span class="comment">// Operators</span>
<a name="l00130"></a>00130                 operator int (<span class="keywordtype">void</span>)                             { <span class="keywordflow">return</span> value; }
<a name="l00131"></a>00131                 <span class="keyword">const</span> <a class="code" href="classIntProperty.html" title="Integer property class.">IntProperty</a>&amp; operator= (<span class="keyword">const</span> <a class="code" href="classIntProperty.html" title="Integer property class.">IntProperty</a> &amp;rhs);
<a name="l00132"></a>00132                 <span class="keywordtype">int</span> operator= (<span class="keywordtype">int</span> rhs);
<a name="l00133"></a>00133 
<a name="l00134"></a>00134         <span class="keyword">private</span>:
<a name="l00135"></a>00135                 <span class="keywordtype">int</span> value;
<a name="l00136"></a>00136 };
<a name="l00137"></a>00137 
<a name="l00140"></a>00140 
<a name="l00142"></a><a class="code" href="classDoubleProperty.html">00142</a> <span class="keyword">class </span>PLAYERCORE_EXPORT <a class="code" href="classDoubleProperty.html" title="Double property class.">DoubleProperty</a> : <span class="keyword">public</span> <a class="code" href="classProperty.html" title="Property base class.">Property</a>
<a name="l00143"></a>00143 {
<a name="l00144"></a>00144         <span class="keyword">public</span>:
<a name="l00145"></a>00145                 <a class="code" href="classDoubleProperty.html" title="Double property class.">DoubleProperty</a> (<span class="keyword">const</span> <span class="keywordtype">char</span> *newKey, <span class="keywordtype">double</span> newValue, <span class="keywordtype">bool</span> readOnly);
<a name="l00147"></a>00147                 <a class="code" href="classDoubleProperty.html" title="Double property class.">DoubleProperty</a> (<span class="keyword">const</span> <span class="keywordtype">char</span> *newKey, <span class="keywordtype">double</span> newValue, <span class="keywordtype">bool</span> readOnly, <a class="code" href="classDriver.html" title="Base class for all drivers.">Driver</a> * driver, <a class="code" href="classConfigFile.html" title="Class for loading configuration file information.">ConfigFile</a>*cf, <span class="keywordtype">int</span> section);
<a name="l00148"></a>00148 
<a name="l00149"></a>00149                 <span class="keywordtype">double</span> GetValue (<span class="keywordtype">void</span>)<span class="keyword"> const            </span>{ <span class="keywordflow">return</span> value; }
<a name="l00150"></a>00150                 <span class="keywordtype">void</span> SetValue (<span class="keywordtype">double</span> newValue);
<a name="l00151"></a>00151                 <span class="keywordtype">void</span> GetValueToMessage (<span class="keywordtype">void</span> *data) <span class="keyword">const</span>;
<a name="l00152"></a>00152                 <span class="keywordtype">void</span> SetValueFromMessage (<span class="keyword">const</span> <span class="keywordtype">void</span> *data);
<a name="l00153"></a>00153 
<a name="l00154"></a>00154                 <span class="comment">// Config file read method</span>
<a name="l00155"></a>00155                 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> ReadConfig (<a class="code" href="classConfigFile.html" title="Class for loading configuration file information.">ConfigFile</a> *cf, <span class="keywordtype">int</span> section);
<a name="l00156"></a>00156 
<a name="l00157"></a>00157                 <span class="comment">// Operators</span>
<a name="l00158"></a>00158                 operator double (<span class="keywordtype">void</span>)                          { <span class="keywordflow">return</span> value; }
<a name="l00159"></a>00159                 <span class="keyword">const</span> <a class="code" href="classDoubleProperty.html" title="Double property class.">DoubleProperty</a>&amp; operator= (<span class="keyword">const</span> <a class="code" href="classDoubleProperty.html" title="Double property class.">DoubleProperty</a> &amp;rhs);
<a name="l00160"></a>00160                 <span class="keywordtype">double</span> operator= (<span class="keywordtype">double</span> rhs);
<a name="l00161"></a>00161 
<a name="l00162"></a>00162         <span class="keyword">private</span>:
<a name="l00163"></a>00163                 <span class="keywordtype">double</span> value;
<a name="l00164"></a>00164 };
<a name="l00165"></a>00165 
<a name="l00168"></a>00168 
<a name="l00170"></a><a class="code" href="classStringProperty.html">00170</a> <span class="keyword">class </span>PLAYERCORE_EXPORT <a class="code" href="classStringProperty.html" title="String Property Class.">StringProperty</a> : <span class="keyword">public</span> <a class="code" href="classProperty.html" title="Property base class.">Property</a>
<a name="l00171"></a>00171 {
<a name="l00172"></a>00172         <span class="keyword">public</span>:
<a name="l00173"></a>00173                 <a class="code" href="classStringProperty.html" title="String Property Class.">StringProperty</a> (<span class="keyword">const</span> <span class="keywordtype">char</span> *newKey, <span class="keyword">const</span> <span class="keywordtype">char</span> *newValue, <span class="keywordtype">bool</span> readOnly);
<a name="l00175"></a>00175                 <a class="code" href="classStringProperty.html" title="String Property Class.">StringProperty</a> (<span class="keyword">const</span> <span class="keywordtype">char</span> *newKey, <span class="keyword">const</span> <span class="keywordtype">char</span> *newValue, <span class="keywordtype">bool</span> readOnly, <a class="code" href="classDriver.html" title="Base class for all drivers.">Driver</a> * driver, <a class="code" href="classConfigFile.html" title="Class for loading configuration file information.">ConfigFile</a>*cf, <span class="keywordtype">int</span> section);
<a name="l00176"></a>00176                 ~<a class="code" href="classStringProperty.html" title="String Property Class.">StringProperty</a> (<span class="keywordtype">void</span>);
<a name="l00177"></a>00177 
<a name="l00178"></a>00178                 <span class="keyword">const</span> <span class="keywordtype">char</span>* GetValue (<span class="keywordtype">void</span>)<span class="keyword"> const       </span>{ <span class="keywordflow">return</span> value; }
<a name="l00179"></a>00179                 <span class="keywordtype">void</span> SetValue (<span class="keyword">const</span> <span class="keywordtype">char</span> *newValue);
<a name="l00180"></a>00180                 <span class="keywordtype">void</span> GetValueToMessage (<span class="keywordtype">void</span> *data) <span class="keyword">const</span>;
<a name="l00181"></a>00181                 <span class="keywordtype">void</span> SetValueFromMessage (<span class="keyword">const</span> <span class="keywordtype">void</span> *data);
<a name="l00182"></a>00182 
<a name="l00183"></a>00183                 <span class="comment">// Config file read method</span>
<a name="l00184"></a>00184                 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> ReadConfig (<a class="code" href="classConfigFile.html" title="Class for loading configuration file information.">ConfigFile</a> *cf, <span class="keywordtype">int</span> section);
<a name="l00185"></a>00185 
<a name="l00186"></a>00186                 <span class="comment">// Operators</span>
<a name="l00187"></a>00187                 operator const char* (<span class="keywordtype">void</span>)                             { <span class="keywordflow">return</span> value; }
<a name="l00188"></a>00188                 <span class="keyword">const</span> <a class="code" href="classStringProperty.html" title="String Property Class.">StringProperty</a>&amp; operator= (<span class="keyword">const</span> <a class="code" href="classStringProperty.html" title="String Property Class.">StringProperty</a> &amp;rhs);
<a name="l00189"></a>00189                 <span class="keyword">const</span> <span class="keywordtype">char</span>* operator= (<span class="keyword">const</span> <span class="keywordtype">char</span>* rhs);
<a name="l00190"></a>00190 
<a name="l00191"></a>00191         <span class="keyword">private</span>:
<a name="l00192"></a>00192                 <span class="keywordtype">char</span> *value;
<a name="l00193"></a>00193 };
<a name="l00194"></a>00194 
<a name="l00197"></a>00197 
<a name="l00199"></a><a class="code" href="structPropertyNode.html">00199</a> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="structPropertyNode.html" title="Property node structure.">PropertyNode</a>
<a name="l00200"></a>00200 {
<a name="l00201"></a>00201         <span class="keywordtype">char</span> *key;
<a name="l00202"></a>00202         <a class="code" href="classProperty.html" title="Property base class.">Property</a> *property;
<a name="l00203"></a>00203         <span class="keyword">struct </span><a class="code" href="structPropertyNode.html" title="Property node structure.">PropertyNode</a> *next;
<a name="l00204"></a>00204 } <a class="code" href="structPropertyNode.html" title="Property node structure.">PropertyNode</a>;
<a name="l00205"></a>00205 
<a name="l00207"></a><a class="code" href="classPropertyBag.html">00207</a> <span class="keyword">class </span>PLAYERCORE_EXPORT <a class="code" href="classPropertyBag.html" title="Property bag class: stores registered properties.">PropertyBag</a>
<a name="l00208"></a>00208 {
<a name="l00209"></a>00209         <span class="keyword">public</span>:
<a name="l00210"></a>00210                 <a class="code" href="classPropertyBag.html" title="Property bag class: stores registered properties.">PropertyBag</a> (<span class="keywordtype">void</span>);
<a name="l00211"></a>00211                 ~<a class="code" href="classPropertyBag.html" title="Property bag class: stores registered properties.">PropertyBag</a> (<span class="keywordtype">void</span>);
<a name="l00212"></a>00212 
<a name="l00213"></a>00213                 <span class="keywordtype">bool</span> AddProperty (<span class="keyword">const</span> <span class="keywordtype">char</span> *key, <a class="code" href="classProperty.html" title="Property base class.">Property</a> *property);
<a name="l00214"></a>00214                 <a class="code" href="classProperty.html" title="Property base class.">Property</a>* GetProperty (<span class="keyword">const</span> <span class="keywordtype">char</span> *key);
<a name="l00215"></a>00215 
<a name="l00216"></a>00216         <span class="keyword">private</span>:
<a name="l00217"></a>00217                 <a class="code" href="structPropertyNode.html" title="Property node structure.">PropertyNode</a> *firstProperty;
<a name="l00218"></a>00218 };
<a name="l00219"></a>00219 
<a name="l00220"></a>00220 <span class="preprocessor">#endif // __PROPERTY_H</span>
</pre></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