Sophie

Sophie

distrib > Mandriva > 2010.0 > i586 > media > contrib-release > by-pkgid > 247b28499c443e092731ffba814075f2 > files > 544

mpqc-html-2.3.1-9mdv2010.0.i586.rpm

<!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::PrefixKeyVal 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&nbsp;Page</span></a></li>
      <li><a href="pages.html"><span>Related&nbsp;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&nbsp;List</span></a></li>
      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
    </ul>
  </div>
  <div class="navpath"><b>sc</b>::<a class="el" href="classsc_1_1PrefixKeyVal.html">PrefixKeyVal</a>
  </div>
</div>
<div class="contents">
<h1>sc::PrefixKeyVal Class Reference</h1><!-- doxytag: class="sc::PrefixKeyVal" --><!-- doxytag: inherits="sc::KeyVal" --><a class="el" href="classsc_1_1PrefixKeyVal.html" title="PrefixKeyVal is a KeyVal that searches a different KeyVal using modified keys.">PrefixKeyVal</a> is a <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> that searches a different <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> using modified keys.  
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="keyval_8h_source.html">keyval.h</a>&gt;</code>
<p>
<div class="dynheader">
Inheritance diagram for sc::PrefixKeyVal:</div>
<div class="dynsection">

<p><center><img src="classsc_1_1PrefixKeyVal.png" usemap="#sc::PrefixKeyVal_map" border="0" alt=""></center>
<map name="sc::PrefixKeyVal_map">
<area href="classsc_1_1KeyVal.html" alt="sc::KeyVal" shape="rect" coords="0,112,105,136">
<area href="classsc_1_1RefCount.html" alt="sc::RefCount" shape="rect" coords="0,56,105,80">
<area href="classsc_1_1Identity.html" alt="sc::Identity" shape="rect" coords="0,0,105,24">
</map>
</div>

<p>
<a href="classsc_1_1PrefixKeyVal-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="24ed4010b9da6a21044a83c6cf530e99"></a><!-- doxytag: member="sc::PrefixKeyVal::errortrace" ref="24ed4010b9da6a21044a83c6cf530e99" args="(std::ostream &amp;fp=ExEnv::err0())" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsc_1_1PrefixKeyVal.html#24ed4010b9da6a21044a83c6cf530e99">errortrace</a> (std::ostream &amp;fp=ExEnv::err0())</td></tr>

<tr><td class="mdescLeft">&nbsp;</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="883c4179bfb8f78289f12bf73e9946c9"></a><!-- doxytag: member="sc::PrefixKeyVal::dump" ref="883c4179bfb8f78289f12bf73e9946c9" args="(std::ostream &amp;fp=ExEnv::err0())" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsc_1_1PrefixKeyVal.html#883c4179bfb8f78289f12bf73e9946c9">dump</a> (std::ostream &amp;fp=ExEnv::err0())</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Write a message to fp describing the error. <br></td></tr>
<tr><td colspan="2"><div class="groupHeader">Constructors.</div></td></tr>
<tr><td colspan="2"><div class="groupText">Construct a <a class="el" href="classsc_1_1PrefixKeyVal.html" title="PrefixKeyVal is a KeyVal that searches a different KeyVal using modified keys.">PrefixKeyVal</a>, using the given prefix and indices.<br><br></div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="44df4da12e1ff532c1f315b263e8dc94"></a><!-- doxytag: member="sc::PrefixKeyVal::PrefixKeyVal" ref="44df4da12e1ff532c1f315b263e8dc94" args="(const Ref&lt; KeyVal &gt; &amp;, int i)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><b>PrefixKeyVal</b> (const <a class="el" href="classsc_1_1Ref.html">Ref</a>&lt; <a class="el" href="classsc_1_1KeyVal.html">KeyVal</a> &gt; &amp;, int i)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="dd27ef7d473b797a5fda254aa2ee4a02"></a><!-- doxytag: member="sc::PrefixKeyVal::PrefixKeyVal" ref="dd27ef7d473b797a5fda254aa2ee4a02" args="(const Ref&lt; KeyVal &gt; &amp;, int i, int j)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><b>PrefixKeyVal</b> (const <a class="el" href="classsc_1_1Ref.html">Ref</a>&lt; <a class="el" href="classsc_1_1KeyVal.html">KeyVal</a> &gt; &amp;, int i, int j)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e1784c69dc4126dcdfdedcde7a87ad96"></a><!-- doxytag: member="sc::PrefixKeyVal::PrefixKeyVal" ref="e1784c69dc4126dcdfdedcde7a87ad96" args="(const Ref&lt; KeyVal &gt; &amp;, int i, int j, int k)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><b>PrefixKeyVal</b> (const <a class="el" href="classsc_1_1Ref.html">Ref</a>&lt; <a class="el" href="classsc_1_1KeyVal.html">KeyVal</a> &gt; &amp;, int i, int j, int k)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ecde7f10a334fb51218987d40a5dd9ae"></a><!-- doxytag: member="sc::PrefixKeyVal::PrefixKeyVal" ref="ecde7f10a334fb51218987d40a5dd9ae" args="(const Ref&lt; KeyVal &gt; &amp;, int i, int j, int k, int l)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><b>PrefixKeyVal</b> (const <a class="el" href="classsc_1_1Ref.html">Ref</a>&lt; <a class="el" href="classsc_1_1KeyVal.html">KeyVal</a> &gt; &amp;, int i, int j, int k, int l)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="742b6fbb4a3883c6942194f61a3c983d"></a><!-- doxytag: member="sc::PrefixKeyVal::PrefixKeyVal" ref="742b6fbb4a3883c6942194f61a3c983d" args="(const Ref&lt; KeyVal &gt; &amp;, const char *prefix)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><b>PrefixKeyVal</b> (const <a class="el" href="classsc_1_1Ref.html">Ref</a>&lt; <a class="el" href="classsc_1_1KeyVal.html">KeyVal</a> &gt; &amp;, const char *prefix)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3e05505c9577b173117f88d9252c52b0"></a><!-- doxytag: member="sc::PrefixKeyVal::PrefixKeyVal" ref="3e05505c9577b173117f88d9252c52b0" args="(const Ref&lt; KeyVal &gt; &amp;, const char *prefix, int i)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><b>PrefixKeyVal</b> (const <a class="el" href="classsc_1_1Ref.html">Ref</a>&lt; <a class="el" href="classsc_1_1KeyVal.html">KeyVal</a> &gt; &amp;, const char *prefix, int i)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d7311f0c275a74a41b42cd8d346dfb25"></a><!-- doxytag: member="sc::PrefixKeyVal::PrefixKeyVal" ref="d7311f0c275a74a41b42cd8d346dfb25" args="(const Ref&lt; KeyVal &gt; &amp;, const char *prefix, int i, int j)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><b>PrefixKeyVal</b> (const <a class="el" href="classsc_1_1Ref.html">Ref</a>&lt; <a class="el" href="classsc_1_1KeyVal.html">KeyVal</a> &gt; &amp;, const char *prefix, int i, int j)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="bf2e3aacdbbf39638b22e2f2de96cd94"></a><!-- doxytag: member="sc::PrefixKeyVal::PrefixKeyVal" ref="bf2e3aacdbbf39638b22e2f2de96cd94" args="(const Ref&lt; KeyVal &gt; &amp;, const char *prefix, int i, int j, int k)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><b>PrefixKeyVal</b> (const <a class="el" href="classsc_1_1Ref.html">Ref</a>&lt; <a class="el" href="classsc_1_1KeyVal.html">KeyVal</a> &gt; &amp;, const char *prefix, int i, int j, int k)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d7fe1fff18c69e57823a211b4cc22197"></a><!-- doxytag: member="sc::PrefixKeyVal::PrefixKeyVal" ref="d7fe1fff18c69e57823a211b4cc22197" args="(const Ref&lt; KeyVal &gt; &amp;, const char *prefix, int i, int j, int k, int l)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><b>PrefixKeyVal</b> (const <a class="el" href="classsc_1_1Ref.html">Ref</a>&lt; <a class="el" href="classsc_1_1KeyVal.html">KeyVal</a> &gt; &amp;, const char *prefix, int i, int j, int k, int l)</td></tr>

</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
<a class="el" href="classsc_1_1PrefixKeyVal.html" title="PrefixKeyVal is a KeyVal that searches a different KeyVal using modified keys.">PrefixKeyVal</a> is a <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> that searches a different <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> using modified keys. 
<p>
This is convenient for reading keys grouped together with a common prefix. Consider the following code: <pre>
    sc::Ref&lt;sc::KeyVal&gt; keyval = new <a class="el" href="classsc_1_1PrefixKeyVal.html" title="PrefixKeyVal is a KeyVal that searches a different KeyVal using modified keys.">sc::PrefixKeyVal</a>("A",original_keyval);
    int r = keyval-&gt;intvalue("x");
    </pre> This code will assign to r the value associated with "x" in keyval. keyval will search for "x" by searching for "A::x" in original_keyval.<p>
This class is important for implementing constructors that take <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> arguments. When an object is being constructed from a <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>, it may contain another object that must be constructed from a <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>. In order to let the sub-object read the correct keywords from the <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>, without knowledge of the containing objects keyword prefix, a <a class="el" href="classsc_1_1PrefixKeyVal.html" title="PrefixKeyVal is a KeyVal that searches a different KeyVal using modified keys.">PrefixKeyVal</a> can be constructed. For example, the code <div class="fragment"><pre class="fragment">    <span class="keyword">class </span>A: <span class="keyword">public</span> DescribedClass {
       <span class="keywordtype">double</span> f0_;
      <span class="keyword">public</span>:
       A(<span class="keyword">const</span> Ref&lt;KeyVal&gt; &amp;keyval): f0_(keyval-&gt;<a class="code" href="classsc_1_1KeyVal.html#f3636a9ab8bf041efe790791a54bb254" title="Returns the double value of key.">doublevalue</a>(<span class="stringliteral">"f0"</span>)) {}
    }
    <span class="keyword">class </span>B: <span class="keyword">public</span> DescribedClass {
       <span class="keywordtype">double</span> f1_;
       Ref&lt;A&gt; a_;
      <span class="keyword">public</span>:
       B(<span class="keyword">const</span> Ref&lt;KeyVal&gt; &amp;keyval):
         f1_(keyval-&gt;<a class="code" href="classsc_1_1KeyVal.html#f3636a9ab8bf041efe790791a54bb254" title="Returns the double value of key.">doublevalue</a>(<span class="stringliteral">"f1"</span>)),
         a_(new PrefixKeyVal(keyval,<span class="stringliteral">"a"</span>))
       {}
    };
</pre></div> can be used to read <a class="el" href="classsc_1_1ParsedKeyVal.html" title="Converts textual information into keyword/value assocations.">ParsedKeyVal</a> input that looks like <pre>
    b&lt;B&gt;: (
      f1 = 1.0
      a&lt;A&gt;: (
        f0 = 2.0
      )
    )
    </pre> <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>

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