<!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>RAUL: Raul::Configuration 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.7.1 -->
<div class="navigation" id="top">
<div class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main 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>
</ul>
</div>
<div class="tabs2">
<ul class="tablist">
<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">
<ul>
<li><b>Raul</b> </li>
<li><a class="el" href="classRaul_1_1Configuration.html">Raul::Configuration</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle">
<h1>Raul::Configuration Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="Raul::Configuration" -->
<p>Program configuration (command line options and/or configuration file).
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="Configuration_8hpp_source.html">Configuration.hpp</a>></code></p>
<p><a href="classRaul_1_1Configuration-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="ae8b9adf140f3f0bd1b3012677cc1541f"></a><!-- doxytag: member="Raul::Configuration::Configuration" ref="ae8b9adf140f3f0bd1b3012677cc1541f" args="(const std::string &shortdesc, const std::string &desc)" -->
</td><td class="memItemRight" valign="bottom"><b>Configuration</b> (const std::string &shortdesc, const std::string &desc)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classRaul_1_1Configuration.html">Configuration</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classRaul_1_1Configuration.html#a9508a88d36f6a7ef2353f1a01b88942d">add</a> (const std::string &name, char letter, const std::string &desc, const Atom::Type type, const <a class="el" href="classRaul_1_1Atom.html">Atom</a> &value)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Add a configuration option. <a href="#a9508a88d36f6a7ef2353f1a01b88942d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af5695e9b49758af8659b97d673dca47c"></a><!-- doxytag: member="Raul::Configuration::print_usage" ref="af5695e9b49758af8659b97d673dca47c" args="(const std::string &program, std::ostream &os)" -->
void </td><td class="memItemRight" valign="bottom"><b>print_usage</b> (const std::string &program, std::ostream &os)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classRaul_1_1Configuration.html#a1cdb37986b2255de63d782b39f368d18">parse</a> (int argc, char **argv) throw (CommandLineError)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Parse command line arguments. <a href="#a1cdb37986b2255de63d782b39f368d18"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad42fb4281cb703d99a0c17d7f480f667"></a><!-- doxytag: member="Raul::Configuration::print" ref="ad42fb4281cb703d99a0c17d7f480f667" args="(std::ostream &os, const std::string mime_type="text/plain") const " -->
void </td><td class="memItemRight" valign="bottom"><b>print</b> (std::ostream &os, const std::string mime_type="text/plain") const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a27901dc6cc7a91b85586577311239540"></a><!-- doxytag: member="Raul::Configuration::option" ref="a27901dc6cc7a91b85586577311239540" args="(const std::string &long_name)" -->
const <a class="el" href="classRaul_1_1Atom.html">Raul::Atom</a> & </td><td class="memItemRight" valign="bottom"><b>option</b> (const std::string &long_name)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Program configuration (command line options and/or configuration file). </p>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a9508a88d36f6a7ef2353f1a01b88942d"></a><!-- doxytag: member="Raul::Configuration::add" ref="a9508a88d36f6a7ef2353f1a01b88942d" args="(const std::string &name, char letter, const std::string &desc, const Atom::Type type, const Atom &value)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classRaul_1_1Configuration.html">Configuration</a> & Raul::Configuration::add </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"> <em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char </td>
<td class="paramname"> <em>letter</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string & </td>
<td class="paramname"> <em>desc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const Atom::Type </td>
<td class="paramname"> <em>type</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classRaul_1_1Atom.html">Atom</a> & </td>
<td class="paramname"> <em>value</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Add a configuration option. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>Long name (without leading "--") </td></tr>
<tr><td valign="top"></td><td valign="top"><em>letter</em> </td><td>Short name (without leading "-") </td></tr>
<tr><td valign="top"></td><td valign="top"><em>desc</em> </td><td>Description </td></tr>
<tr><td valign="top"></td><td valign="top"><em>type</em> </td><td>Type (Atom::BOOL for flags) </td></tr>
<tr><td valign="top"></td><td valign="top"><em>value</em> </td><td>Default value </td></tr>
</table>
</dd>
</dl>
<p>References <a class="el" href="classRaul_1_1Atom.html#a9221752e4e19d52178388d811815c33c">Raul::Atom::type()</a>.</p>
</div>
</div>
<a class="anchor" id="a1cdb37986b2255de63d782b39f368d18"></a><!-- doxytag: member="Raul::Configuration::parse" ref="a1cdb37986b2255de63d782b39f368d18" args="(int argc, char **argv)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Raul::Configuration::parse </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>argc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char ** </td>
<td class="paramname"> <em>argv</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td> throw (CommandLineError)</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Parse command line arguments. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="Configuration_8hpp_source.html">Configuration.hpp</a></li>
<li>Configuration.cpp</li>
</ul>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Wed Oct 6 2010 for RAUL by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.1 </small></address>
</body>
</html>
distrib
>
Fedora
>
14
>
x86_64
>
media
>
updates
>
by-pkgid
>
88959ca903fe50462ea99715ead18944
>
files
>
102
