<!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::HelperModule 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="a00046.html">HelperModule</a>
</div>
</div>
<div class="contents">
<h1>scim::HelperModule Class Reference<br>
<small>
[<a class="el" href="a00163.html">Helper</a>]</small>
</h1><!-- doxytag: class="scim::HelperModule" -->The class used to load a Helper module and run its Helpers.
<a href="#_details">More...</a>
<p>
<code>#include <scim_helper_module.h></code>
<p>
<p>
<a href="a00247.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="a00046.html#ee7cf95976a18c973b59ea354bcd3864">HelperModule</a> (const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> &name=<a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a>(""))</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#ee7cf95976a18c973b59ea354bcd3864"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00046.html#10b354f6aed301be7ff75e84a4818fce">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 Helper module. <a href="#10b354f6aed301be7ff75e84a4818fce"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00046.html#d3b19beb4665996c94d3e7452d282bd0">unload</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Unload the module. <a href="#d3b19beb4665996c94d3e7452d282bd0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00046.html#4fbaa4a30c6876417a9ec7b46f694952">valid</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Check if a Helper module has been loaded successfully. <a href="#4fbaa4a30c6876417a9ec7b46f694952"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00046.html#fdd7bfc4cfc38a5771a81c24a081e0f1">number_of_helpers</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the number of helpers supported by this module. <a href="#fdd7bfc4cfc38a5771a81c24a081e0f1"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00046.html#13813d36365ebefecbd3c0e255cb0601">get_helper_info</a> (unsigned int idx, <a class="el" href="a00044.html">HelperInfo</a> &info) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The the information of a specific helper. <a href="#13813d36365ebefecbd3c0e255cb0601"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00046.html#14523ff3221861551dc6118bc772d9da">run_helper</a> (const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> &uuid, const <a class="el" href="a00070.html">ConfigPointer</a> &config, const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> &display) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Run a specific helper. <a href="#14523ff3221861551dc6118bc772d9da"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
The class used to load a Helper module and run its Helpers.
<p>
This class should not be used directly. <a class="el" href="a00045.html" title="This class is used to manage all helper objects.">HelperManager</a> should be used instead. <hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="ee7cf95976a18c973b59ea354bcd3864"></a><!-- doxytag: member="scim::HelperModule::HelperModule" ref="ee7cf95976a18c973b59ea354bcd3864" args="(const String &name=String(""))" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">scim::HelperModule::HelperModule </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> & </td>
<td class="paramname"> <em>name</em> = <code><a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a>("")</code> </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 name of the Helper module to be loaded. </td></tr>
</table>
</dl>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="10b354f6aed301be7ff75e84a4818fce"></a><!-- doxytag: member="scim::HelperModule::load" ref="10b354f6aed301be7ff75e84a4818fce" args="(const String &name)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool scim::HelperModule::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 Helper module.
<p>
If a module has already been loaded, then it'll be unloaded first.<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 name of the Helper module to be loaded. </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="d3b19beb4665996c94d3e7452d282bd0"></a><!-- doxytag: member="scim::HelperModule::unload" ref="d3b19beb4665996c94d3e7452d282bd0" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool scim::HelperModule::unload </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Unload the module.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>true if success. </dd></dl>
</div>
</div><p>
<a class="anchor" name="4fbaa4a30c6876417a9ec7b46f694952"></a><!-- doxytag: member="scim::HelperModule::valid" ref="4fbaa4a30c6876417a9ec7b46f694952" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool scim::HelperModule::valid </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Check if a Helper module has been loaded successfully.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>true if a module has been loaded successfully. </dd></dl>
</div>
</div><p>
<a class="anchor" name="fdd7bfc4cfc38a5771a81c24a081e0f1"></a><!-- doxytag: member="scim::HelperModule::number_of_helpers" ref="fdd7bfc4cfc38a5771a81c24a081e0f1" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned int scim::HelperModule::number_of_helpers </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the number of helpers supported by this module.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the number of helpers supported by this module. </dd></dl>
</div>
</div><p>
<a class="anchor" name="13813d36365ebefecbd3c0e255cb0601"></a><!-- doxytag: member="scim::HelperModule::get_helper_info" ref="13813d36365ebefecbd3c0e255cb0601" args="(unsigned int idx, HelperInfo &info) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool scim::HelperModule::get_helper_info </td>
<td>(</td>
<td class="paramtype">unsigned int </td>
<td class="paramname"> <em>idx</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="a00044.html">HelperInfo</a> & </td>
<td class="paramname"> <em>info</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
The the information of a specific helper.
<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>idx</em> </td><td>The index of the helper, must between 0 to number_of_helpers () - 1. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>info</em> </td><td>The HeperInfo object to store the information. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>true if this helper is ok and the information is stored into info successfully. </dd></dl>
</div>
</div><p>
<a class="anchor" name="14523ff3221861551dc6118bc772d9da"></a><!-- doxytag: member="scim::HelperModule::run_helper" ref="14523ff3221861551dc6118bc772d9da" args="(const String &uuid, const ConfigPointer &config, const String &display) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void scim::HelperModule::run_helper </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> & </td>
<td class="paramname"> <em>uuid</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="a00070.html">ConfigPointer</a> & </td>
<td class="paramname"> <em>config</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> & </td>
<td class="paramname"> <em>display</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Run a specific helper.
<p>
The helper should be run in an independent process, this function will not return until the helper exits.<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>config</em> </td><td>The Config object to be used to read configurations. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>uuid</em> </td><td>The UUID of the helper, which is returned by get_helper_info (). </td></tr>
<tr><td valign="top"></td><td valign="top"><em>display</em> </td><td>The display in which this helper should run. </td></tr>
</table>
</dl>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="a00133.html">scim_helper_module.h</a></ul>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Sun Apr 19 13:02:41 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>
