<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> <title>MPQC: sc::StringKeyVal Class Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"> <link href="doxygen.css" rel="stylesheet" type="text/css"> </head><body> <!-- Generated by Doxygen 1.5.9 --> <div class="navigation" id="top"> <div class="tabs"> <ul> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="pages.html"><span>Related Pages</span></a></li> <li class="current"><a href="annotated.html"><span>Classes</span></a></li> <li><a href="files.html"><span>Files</span></a></li> </ul> </div> <div class="tabs"> <ul> <li><a href="annotated.html"><span>Class List</span></a></li> <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> <li><a href="functions.html"><span>Class Members</span></a></li> </ul> </div> <div class="navpath"><b>sc</b>::<a class="el" href="classsc_1_1StringKeyVal.html">StringKeyVal</a> </div> </div> <div class="contents"> <h1>sc::StringKeyVal Class Reference</h1><!-- doxytag: class="sc::StringKeyVal" --><!-- doxytag: inherits="sc::KeyVal" --><a class="el" href="classsc_1_1StringKeyVal.html" title="StringKeyVal is a base class for KeyVal implementations that store all values in...">StringKeyVal</a> is a base class for <a class="el" href="classsc_1_1KeyVal.html" title="The KeyVal class is designed to simplify the process of allowing a user to specify...">KeyVal</a> implementations that store all values in a string format. <a href="#_details">More...</a> <p> <code>#include <<a class="el" href="keyval_8h_source.html">keyval.h</a>></code> <p> <div class="dynheader"> Inheritance diagram for sc::StringKeyVal:</div> <div class="dynsection"> <p><center><img src="classsc_1_1StringKeyVal.png" usemap="#sc::StringKeyVal_map" border="0" alt=""></center> <map name="sc::StringKeyVal_map"> <area href="classsc_1_1KeyVal.html" alt="sc::KeyVal" shape="rect" coords="0,112,112,136"> <area href="classsc_1_1RefCount.html" alt="sc::RefCount" shape="rect" coords="0,56,112,80"> <area href="classsc_1_1Identity.html" alt="sc::Identity" shape="rect" coords="0,0,112,24"> <area href="classsc_1_1ParsedKeyVal.html" alt="sc::ParsedKeyVal" shape="rect" coords="0,224,112,248"> </map> </div> <p> <a href="classsc_1_1StringKeyVal-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0"> <tr><td></td></tr> <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d25f77186f19d64a8afae8d6e4fe2cf2"></a><!-- doxytag: member="sc::StringKeyVal::stringrep" ref="d25f77186f19d64a8afae8d6e4fe2cf2" args="(const char *key)=0" --> virtual const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classsc_1_1StringKeyVal.html#d25f77186f19d64a8afae8d6e4fe2cf2">stringrep</a> (const char *key)=0</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the string representation of the value assigned to key. <br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classsc_1_1StringKeyVal.html#fb9a4aed8a075fb6107401b9911d763a">classname</a> (const char *)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the name of the exact class of the object at the keyword. <a href="#fb9a4aed8a075fb6107401b9911d763a"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classsc_1_1StringKeyVal.html#36d1d26e0370f92907745990834e447b">truekeyword</a> (const char *)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns a string which is the actual keyword if some sort of variable substitution takes place (needed to make multiple references to the same object work in input files). <a href="#36d1d26e0370f92907745990834e447b"></a><br></td></tr> <tr><td colspan="2"><div class="groupHeader">Debugging.</div></td></tr> <tr><td colspan="2"><div class="groupText">See the parent class documentation for descriptions of these functions. <br><br></div></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="49bf120d3bac62ea257dd680c038e5bb"></a><!-- doxytag: member="sc::StringKeyVal::errortrace" ref="49bf120d3bac62ea257dd680c038e5bb" args="(std::ostream &fp=ExEnv::err0())" --> virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsc_1_1StringKeyVal.html#49bf120d3bac62ea257dd680c038e5bb">errortrace</a> (std::ostream &fp=ExEnv::err0())</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Write a message to fp describing the error. <br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="36635c3aaf294a5b16ad08e56d14f586"></a><!-- doxytag: member="sc::StringKeyVal::dump" ref="36635c3aaf294a5b16ad08e56d14f586" args="(std::ostream &fp=ExEnv::err0())" --> virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsc_1_1StringKeyVal.html#36635c3aaf294a5b16ad08e56d14f586">dump</a> (std::ostream &fp=ExEnv::err0())</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Write a message to fp describing the error. <br></td></tr> <tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c46b628bf4f8c893ee98735488c6820c"></a><!-- doxytag: member="sc::StringKeyVal::key_exists" ref="c46b628bf4f8c893ee98735488c6820c" args="(const char *)" --> int </td><td class="memItemRight" valign="bottom"><a class="el" href="classsc_1_1StringKeyVal.html#c46b628bf4f8c893ee98735488c6820c">key_exists</a> (const char *)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Ultimately called by exists. <br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d45e463541cdc75c37213a7888d2da88"></a><!-- doxytag: member="sc::StringKeyVal::key_value" ref="d45e463541cdc75c37213a7888d2da88" args="(const char *, const KeyValValue &def)" --> <a class="el" href="classsc_1_1Ref.html">Ref</a>< KeyValValue > </td><td class="memItemRight" valign="bottom"><a class="el" href="classsc_1_1StringKeyVal.html#d45e463541cdc75c37213a7888d2da88">key_value</a> (const char *, const KeyValValue &def)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Ultimately called by value. <br></td></tr> </table> <hr><a name="_details"></a><h2>Detailed Description</h2> <a class="el" href="classsc_1_1StringKeyVal.html" title="StringKeyVal is a base class for KeyVal implementations that store all values in...">StringKeyVal</a> is a base class for <a class="el" href="classsc_1_1KeyVal.html" title="The KeyVal class is designed to simplify the process of allowing a user to specify...">KeyVal</a> implementations that store all values in a string format. <p> These are converted to other data types through KeyValValue. <hr><h2>Member Function Documentation</h2> <a class="anchor" name="fb9a4aed8a075fb6107401b9911d763a"></a><!-- doxytag: member="sc::StringKeyVal::classname" ref="fb9a4aed8a075fb6107401b9911d763a" args="(const char *)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual const char* sc::StringKeyVal::classname </td> <td>(</td> <td class="paramtype">const char * </td> <td class="paramname"> </td> <td> ) </td> <td><code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Returns the name of the exact class of the object at the keyword. <p> If no classname is assigned then 0 is returned. <p>Reimplemented in <a class="el" href="classsc_1_1ParsedKeyVal.html#94e1c024959a746195dbd4c4563c25e3">sc::ParsedKeyVal</a>.</p> </div> </div><p> <a class="anchor" name="36d1d26e0370f92907745990834e447b"></a><!-- doxytag: member="sc::StringKeyVal::truekeyword" ref="36d1d26e0370f92907745990834e447b" args="(const char *)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual const char* sc::StringKeyVal::truekeyword </td> <td>(</td> <td class="paramtype">const char * </td> <td class="paramname"> </td> <td> ) </td> <td><code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Returns a string which is the actual keyword if some sort of variable substitution takes place (needed to make multiple references to the same object work in input files). <p> <p>Reimplemented in <a class="el" href="classsc_1_1ParsedKeyVal.html#9b5e45f75930e29755f0e166a390efbe">sc::ParsedKeyVal</a>.</p> </div> </div><p> <hr>The documentation for this class was generated from the following file:<ul> <li><a class="el" href="keyval_8h_source.html">keyval.h</a></ul> </div> <hr> <address> <small> Generated at Wed Oct 14 14:12:17 2009 for <a href="http://www.mpqc.org">MPQC</a> 2.3.1 using the documentation package <a href="http://www.doxygen.org">Doxygen</a> 1.5.9. </small> </address> </body> </html>