Sophie

Sophie

distrib > Fedora > 14 > x86_64 > by-pkgid > 2aa62c5bbb658df1fece777472a7bcf2 > files > 461

barry-devel-docs-0.17-0.3.20100730git.fc14.noarch.rpm

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>Barry: Barry::GlobalConfigFile 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.6.2-20100208 -->
<div class="navigation" id="top">
  <div class="tabs">
    <ul>
      <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</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>
      <li><a href="dirs.html"><span>Directories</span></a></li>
    </ul>
  </div>
  <div class="tabs">
    <ul>
      <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
      <li><a href="classes.html"><span>Class&nbsp;Index</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"><a class="el" href="namespaceBarry.html">Barry</a>::<a class="el" href="classBarry_1_1GlobalConfigFile.html">GlobalConfigFile</a>
  </div>
</div>
<div class="contents">
<h1>Barry::GlobalConfigFile Class Reference</h1><!-- doxytag: class="Barry::GlobalConfigFile" --><div class="dynheader">
Collaboration diagram for Barry::GlobalConfigFile:</div>
<div class="dynsection">
<div class="center"><img src="classBarry_1_1GlobalConfigFile__coll__graph.png" border="0" usemap="#Barry_1_1GlobalConfigFile_coll__map" alt="Collaboration graph"/></div>
<map name="Barry_1_1GlobalConfigFile_coll__map" id="Barry_1_1GlobalConfigFile_coll__map">
<area shape="rect" id="node2" href="classBarry_1_1Pin.html" title="Barry::Pin" alt="" coords="5,227,85,258"/><area shape="rect" id="node6" title="STL class." alt="" coords="129,89,209,119"/><area shape="rect" id="node8" title="STL class." alt="" coords="85,6,253,37"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>

<p><a href="classBarry_1_1GlobalConfigFile-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBarry_1_1GlobalConfigFile.html#a2eb522741d05030a0f28f61c41afa5a0">GlobalConfigFile</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Loads the global config file.  <a href="#a2eb522741d05030a0f28f61c41afa5a0"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBarry_1_1GlobalConfigFile.html#a80ab4bc24a514e06ed9a1150e49a40a2">GlobalConfigFile</a> (const std::string &amp;appname)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Loads the global config file, as well as any application-specific keywords and variables.  <a href="#a80ab4bc24a514e06ed9a1150e49a40a2"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBarry_1_1GlobalConfigFile.html#a51eb5ad1d623f66e4bb3c7b8d43eeebb">Save</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Save the current global config, overwriting or creating as needed.  <a href="#a51eb5ad1d623f66e4bb3c7b8d43eeebb"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBarry_1_1GlobalConfigFile.html#a529c89e13dc9ca1be81483ce231fb090">SetKey</a> (const std::string &amp;key, const std::string &amp;value)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Throws std::logic_error if not constructed with an appname.  <a href="#a529c89e13dc9ca1be81483ce231fb090"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>

<p>Definition at line <a class="el" href="configfile_8h_source.html#l00131">131</a> of file <a class="el" href="configfile_8h_source.html">configfile.h</a>.</p>
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a2eb522741d05030a0f28f61c41afa5a0"></a><!-- doxytag: member="Barry::GlobalConfigFile::GlobalConfigFile" ref="a2eb522741d05030a0f28f61c41afa5a0" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">Barry::GlobalConfigFile::GlobalConfigFile </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Loads the global config file. </p>
<p>Throws <a class="el" href="classBarry_1_1ConfigFileError.html" title="Thrown by the ConfigFile class when encountering a serious system error while loading...">ConfigFileError</a> on error, but it is not an error if the config does not exist. </p>

<p>Definition at line <a class="el" href="configfile_8cc_source.html#l00326">326</a> of file <a class="el" href="configfile_8cc_source.html">configfile.cc</a>.</p>

</div>
</div>
<a class="anchor" id="a80ab4bc24a514e06ed9a1150e49a40a2"></a><!-- doxytag: member="Barry::GlobalConfigFile::GlobalConfigFile" ref="a80ab4bc24a514e06ed9a1150e49a40a2" args="(const std::string &amp;appname)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">Barry::GlobalConfigFile::GlobalConfigFile </td>
          <td>(</td>
          <td class="paramtype">const std::string &amp;&nbsp;</td>
          <td class="paramname"> <em>appname</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Loads the global config file, as well as any application-specific keywords and variables. </p>
<p>Use this if you wish to make use of <a class="el" href="classBarry_1_1GlobalConfigFile.html#a529c89e13dc9ca1be81483ce231fb090" title="Throws std::logic_error if not constructed with an appname.">SetKey()</a> and GetKey(), otherwise these functions will throw and exception since they don't have an application name. </p>

<p>Definition at line <a class="el" href="configfile_8cc_source.html#l00334">334</a> of file <a class="el" href="configfile_8cc_source.html">configfile.cc</a>.</p>

</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a51eb5ad1d623f66e4bb3c7b8d43eeebb"></a><!-- doxytag: member="Barry::GlobalConfigFile::Save" ref="a51eb5ad1d623f66e4bb3c7b8d43eeebb" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool Barry::GlobalConfigFile::Save </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Save the current global config, overwriting or creating as needed. </p>

<p>Definition at line <a class="el" href="configfile_8cc_source.html#l00413">413</a> of file <a class="el" href="configfile_8cc_source.html">configfile.cc</a>.</p>

<p>References <a class="el" href="configfile_8cc_source.html#l00286">Barry::ConfigFile::CheckPath()</a>.</p>

<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dynsection">
<div class="center"><img src="classBarry_1_1GlobalConfigFile_a51eb5ad1d623f66e4bb3c7b8d43eeebb_cgraph.png" border="0" usemap="#classBarry_1_1GlobalConfigFile_a51eb5ad1d623f66e4bb3c7b8d43eeebb_cgraph_map" alt=""></div>
<map name="classBarry_1_1GlobalConfigFile_a51eb5ad1d623f66e4bb3c7b8d43eeebb_cgraph_map" id="classBarry_1_1GlobalConfigFile_a51eb5ad1d623f66e4bb3c7b8d43eeebb_cgraph">
<area shape="rect" id="node3" href="classBarry_1_1ConfigFile.html#af06a343c8df13c801348ed0b4d781b46" title="Checks that the path in path exists, and if not, creates it." alt="" coords="257,5,452,35"/></map>
</div>
</p>

</div>
</div>
<a class="anchor" id="a529c89e13dc9ca1be81483ce231fb090"></a><!-- doxytag: member="Barry::GlobalConfigFile::SetKey" ref="a529c89e13dc9ca1be81483ce231fb090" args="(const std::string &amp;key, const std::string &amp;value)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void Barry::GlobalConfigFile::SetKey </td>
          <td>(</td>
          <td class="paramtype">const std::string &amp;&nbsp;</td>
          <td class="paramname"> <em>key</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const std::string &amp;&nbsp;</td>
          <td class="paramname"> <em>value</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Throws std::logic_error if not constructed with an appname. </p>

<p>Definition at line <a class="el" href="configfile_8cc_source.html#l00443">443</a> of file <a class="el" href="configfile_8cc_source.html">configfile.cc</a>.</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="configfile_8h_source.html">configfile.h</a></li>
<li><a class="el" href="configfile_8cc_source.html">configfile.cc</a></li>
</ul>
</div>
<hr class="footer"/><address style="text-align: right;"><small>Generated by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.2-20100208 </small></address>
</body>
</html>