<!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-methods">Public Member Functions</a> | <a href="#pri-attribs">Private Attributes</a> </div> <div class="headertitle"> <h1>StringProperty Class Reference</h1> </div> </div> <div class="contents"> <!-- doxytag: class="StringProperty" --><!-- doxytag: inherits="Property" --> <p>String <a class="el" href="classProperty.html" title="Property base class.">Property</a> Class. <a href="#_details">More...</a></p> <p><code>#include <<a class="el" href="property_8h_source.html">property.h</a>></code></p> <div class="dynheader"> Inheritance diagram for StringProperty:</div> <div class="dyncontent"> <div class="center"> <img src="classStringProperty.png" usemap="#StringProperty_map" alt=""/> <map id="StringProperty_map" name="StringProperty_map"> <area href="classProperty.html" alt="Property" shape="rect" coords="0,0,94,24"/> </map> </div> <p><a href="classStringProperty-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="ac70f85ae2dfd3a425611f5a7f721d480"></a><!-- doxytag: member="StringProperty::StringProperty" ref="ac70f85ae2dfd3a425611f5a7f721d480" args="(const char *newKey, const char *newValue, bool readOnly)" --> </td><td class="memItemRight" valign="bottom"><b>StringProperty</b> (const char *newKey, const char *newValue, bool readOnly)</td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7c20d58c8b384047322b8f8acf3cef18"></a><!-- doxytag: member="StringProperty::StringProperty" ref="a7c20d58c8b384047322b8f8acf3cef18" args="(const char *newKey, const char *newValue, bool readOnly, Driver *driver, ConfigFile *cf, int section)" --> </td><td class="memItemRight" valign="bottom"><a class="el" href="classStringProperty.html#a7c20d58c8b384047322b8f8acf3cef18">StringProperty</a> (const char *newKey, const char *newValue, bool readOnly, <a class="el" href="classDriver.html">Driver</a> *driver, <a class="el" href="classConfigFile.html">ConfigFile</a> *cf, int section)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor that registers the property with a driver as well while it is constructed. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af959a6aa78629c2054666ece8dd21646"></a><!-- doxytag: member="StringProperty::GetValue" ref="af959a6aa78629c2054666ece8dd21646" args="(void) const " --> const char * </td><td class="memItemRight" valign="bottom"><b>GetValue</b> (void) const </td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0a0e8c076e3591c16d4a8da84c856d9f"></a><!-- doxytag: member="StringProperty::SetValue" ref="a0a0e8c076e3591c16d4a8da84c856d9f" args="(const char *newValue)" --> void </td><td class="memItemRight" valign="bottom"><b>SetValue</b> (const char *newValue)</td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a802cbb47644e62b4d6e64f6a0cc0bef3"></a><!-- doxytag: member="StringProperty::GetValueToMessage" ref="a802cbb47644e62b4d6e64f6a0cc0bef3" args="(void *data) const " --> void </td><td class="memItemRight" valign="bottom"><b>GetValueToMessage</b> (void *data) const </td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0d2ef59a9d6b482133d57fe7544bd6bc"></a><!-- doxytag: member="StringProperty::SetValueFromMessage" ref="a0d2ef59a9d6b482133d57fe7544bd6bc" args="(const void *data)" --> void </td><td class="memItemRight" valign="bottom"><b>SetValueFromMessage</b> (const void *data)</td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acc69605d02922974a4f4445b76a6d0c5"></a><!-- doxytag: member="StringProperty::ReadConfig" ref="acc69605d02922974a4f4445b76a6d0c5" args="(ConfigFile *cf, int section)" --> virtual bool </td><td class="memItemRight" valign="bottom"><b>ReadConfig</b> (<a class="el" href="classConfigFile.html">ConfigFile</a> *cf, int section)</td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac8940d37e353d7879a6b1c0ac3e7be55"></a><!-- doxytag: member="StringProperty::operator const char *" ref="ac8940d37e353d7879a6b1c0ac3e7be55" args="(void)" --> </td><td class="memItemRight" valign="bottom"><b>operator const char *</b> (void)</td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a05d2d637528aa32c5bb5885249052a7e"></a><!-- doxytag: member="StringProperty::operator=" ref="a05d2d637528aa32c5bb5885249052a7e" args="(const StringProperty &rhs)" --> const <a class="el" href="classStringProperty.html">StringProperty</a> & </td><td class="memItemRight" valign="bottom"><b>operator=</b> (const <a class="el" href="classStringProperty.html">StringProperty</a> &rhs)</td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8c585057e5fa548bb6e994961b9e0206"></a><!-- doxytag: member="StringProperty::operator=" ref="a8c585057e5fa548bb6e994961b9e0206" args="(const char *rhs)" --> const char * </td><td class="memItemRight" valign="bottom"><b>operator=</b> (const char *rhs)</td></tr> <tr><td colspan="2"><h2><a name="pri-attribs"></a> Private Attributes</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7b97b1f9a622e0799df9e7904fb56e17"></a><!-- doxytag: member="StringProperty::value" ref="a7b97b1f9a622e0799df9e7904fb56e17" args="" --> char * </td><td class="memItemRight" valign="bottom"><b>value</b></td></tr> </table> <hr/><a name="_details"></a><h2>Detailed Description</h2> <p>String <a class="el" href="classProperty.html" title="Property base class.">Property</a> 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>