1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<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.0 -->
<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 id="current"><a href="classes.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="classes.html"><span>Alphabetical List</span></a></li>
<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="nav">
<a class="el" href="a00157.html">scim</a>::<a class="el" href="a00016.html">ConfigModule</a></div>
<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>
Collaboration diagram for scim::ConfigModule:<p><center><img src="a00307.png" border="0" usemap="#a00308" alt="Collaboration graph"></center>
<map name="a00308">
<area href="a00063.html" shape="rect" coords="27,8,128,32" alt="">
</map>
<center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center><a href="a00309.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#1225024338f969f2d3acdfeb8d747556">valid</a> () const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Check if a module is loaded and initialized successfully. <a href="#1225024338f969f2d3acdfeb8d747556"></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#d3b9c701a135d57f20d02df8cc912f72">create_config</a> () const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a configuration object from this module. <a href="#d3b9c701a135d57f20d02df8cc912f72"></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.
<p>
<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 width="100%"></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 width="100%"></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 width="100%"></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="1225024338f969f2d3acdfeb8d747556"></a><!-- doxytag: member="scim::ConfigModule::valid" ref="1225024338f969f2d3acdfeb8d747556" 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 width="100%"> 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="d3b9c701a135d57f20d02df8cc912f72"></a><!-- doxytag: member="scim::ConfigModule::create_config" ref="d3b9c701a135d57f20d02df8cc912f72" 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 width="100%"> 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">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>
<hr size="1"><address style="align: right;"><small>Generated on Thu Jun 28 14:12:37 2007 for scim by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.0 </small></address>
</body>
</html>
|
