<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>scim: scim::ConfigModule Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.7.1 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="main.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="tabs">
<ul>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</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"><a class="el" href="a00157.html">scim</a>::<a class="el" href="a00016.html">ConfigModule</a>
</div>
</div>
<div class="contents">
<h1>scim::ConfigModule Class Reference<br>
<small>
[<a class="el" href="a00161.html">Config</a>]</small>
</h1><!-- doxytag: class="scim::ConfigModule" -->The class to manipulate the config modules.
<a href="#_details">More...</a>
<p>
<code>#include <scim_config_module.h></code>
<p>
<p>
<a href="a00228.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"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00016.html#460d0b66d5f6e4a8f74d1eeed4d4367d">ConfigModule</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <a href="#460d0b66d5f6e4a8f74d1eeed4d4367d"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00016.html#07ddd7fdaf7d9c4697e6bc5c2e602fd3">ConfigModule</a> (const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> &name)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#07ddd7fdaf7d9c4697e6bc5c2e602fd3"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00016.html#a81938cfdad9924c0bfc153cab0b5852">load</a> (const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> &name)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Load a module by its name. <a href="#a81938cfdad9924c0bfc153cab0b5852"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00016.html#1ef258b6569e2a0585b234c1261e44e2">valid</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Check if a module is loaded and initialized successfully. <a href="#1ef258b6569e2a0585b234c1261e44e2"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="a00070.html">ConfigPointer</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00016.html#c336148db8fb8179eef223a1bb54b7c7">create_config</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a configuration object from this module. <a href="#c336148db8fb8179eef223a1bb54b7c7"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
The class to manipulate the config modules.
<p>
This is a wrapper of <a class="el" href="a00063.html">scim::Module</a> class, which is specially for manipulating the config modules. <hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="460d0b66d5f6e4a8f74d1eeed4d4367d"></a><!-- doxytag: member="scim::ConfigModule::ConfigModule" ref="460d0b66d5f6e4a8f74d1eeed4d4367d" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">scim::ConfigModule::ConfigModule </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Default constructor.
<p>
</div>
</div><p>
<a class="anchor" name="07ddd7fdaf7d9c4697e6bc5c2e602fd3"></a><!-- doxytag: member="scim::ConfigModule::ConfigModule" ref="07ddd7fdaf7d9c4697e6bc5c2e602fd3" args="(const String &name)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">scim::ConfigModule::ConfigModule </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> & </td>
<td class="paramname"> <em>name</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Constructor.
<p>
<dl compact><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>- the module's name, eg. "simple". </td></tr>
</table>
</dl>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="a81938cfdad9924c0bfc153cab0b5852"></a><!-- doxytag: member="scim::ConfigModule::load" ref="a81938cfdad9924c0bfc153cab0b5852" args="(const String &name)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool scim::ConfigModule::load </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> & </td>
<td class="paramname"> <em>name</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Load a module by its name.
<p>
Load a module into memory. If another module has been loaded into this object, then the old module will be unloaded first. If the old module is resident, false will be returned, and the old module will be untouched.<p>
<dl compact><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>- the module's name, eg. "simple". </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>true if success. </dd></dl>
</div>
</div><p>
<a class="anchor" name="1ef258b6569e2a0585b234c1261e44e2"></a><!-- doxytag: member="scim::ConfigModule::valid" ref="1ef258b6569e2a0585b234c1261e44e2" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool scim::ConfigModule::valid </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Check if a module is loaded and initialized successfully.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>true if a module is already loaded and initialized successfully. </dd></dl>
</div>
</div><p>
<a class="anchor" name="c336148db8fb8179eef223a1bb54b7c7"></a><!-- doxytag: member="scim::ConfigModule::create_config" ref="c336148db8fb8179eef223a1bb54b7c7" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00070.html">ConfigPointer</a> scim::ConfigModule::create_config </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Create a configuration object from this module.
<p>
The type of newly created configuration object must be a derived class of <a class="el" href="a00014.html" title="The interface class to access the configuration data.">scim::ConfigBase</a>.<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>a smart pointer points to the configuration object. </dd></dl>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="a00119.html">scim_config_module.h</a></ul>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Sun Apr 19 13:02:39 2009 for scim by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.7.1 </small></address>
</body>
</html>
