<!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::HelperManager 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="a00045.html">HelperManager</a>
</div>
</div>
<div class="contents">
<h1>scim::HelperManager Class Reference<br>
<small>
[<a class="el" href="a00163.html">Helper</a>]</small>
</h1><!-- doxytag: class="scim::HelperManager" -->This class is used to manage all helper objects.
<a href="#_details">More...</a>
<p>
<code>#include <scim_helper_manager.h></code>
<p>
<p>
<a href="a00246.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="a00045.html#14f73d33ca3f6ba14b79645e6d96c98c">HelperManager</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00045.html#a271817b7be5ae7a4d1a107e208cb3e9">~HelperManager</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00045.html#e12de3da8a4b004b2232419c6515629a">number_of_helpers</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the total number of helpers supported by all helper modules. <a href="#e12de3da8a4b004b2232419c6515629a"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00045.html#0a16de9cd1dcc2faf12edf9565d472b7">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">Get the information of a specific helper by its index. <a href="#0a16de9cd1dcc2faf12edf9565d472b7"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00045.html#e3cf943456f1a67d543c0e9dd79bb2df">run_helper</a> (const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> &uuid, const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> &config_name, 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="#e3cf943456f1a67d543c0e9dd79bb2df"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
This class is used to manage all helper objects. <hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="14f73d33ca3f6ba14b79645e6d96c98c"></a><!-- doxytag: member="scim::HelperManager::HelperManager" ref="14f73d33ca3f6ba14b79645e6d96c98c" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">scim::HelperManager::HelperManager </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="a271817b7be5ae7a4d1a107e208cb3e9"></a><!-- doxytag: member="scim::HelperManager::~HelperManager" ref="a271817b7be5ae7a4d1a107e208cb3e9" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">scim::HelperManager::~HelperManager </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="e12de3da8a4b004b2232419c6515629a"></a><!-- doxytag: member="scim::HelperManager::number_of_helpers" ref="e12de3da8a4b004b2232419c6515629a" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned int scim::HelperManager::number_of_helpers </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the total number of helpers supported by all helper modules.
<p>
</div>
</div><p>
<a class="anchor" name="0a16de9cd1dcc2faf12edf9565d472b7"></a><!-- doxytag: member="scim::HelperManager::get_helper_info" ref="0a16de9cd1dcc2faf12edf9565d472b7" args="(unsigned int idx, HelperInfo &info) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool scim::HelperManager::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>
Get the information of a specific helper by its index.
<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 <a class="el" href="a00044.html" title="Structure to hold the information of a Helper object.">HelperInfo</a> 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 correctly. </dd></dl>
</div>
</div><p>
<a class="anchor" name="e3cf943456f1a67d543c0e9dd79bb2df"></a><!-- doxytag: member="scim::HelperManager::run_helper" ref="e3cf943456f1a67d543c0e9dd79bb2df" args="(const String &uuid, const String &config_name, const String &display) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void scim::HelperManager::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="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> & </td>
<td class="paramname"> <em>config_name</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 will run in a newly forked process, so this function will return as soon as the new process is launched.<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_name</em> </td><td>The name of the <a class="el" href="a00016.html" title="The class to manipulate the config modules.">ConfigModule</a> 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 to be run. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>display</em> </td><td>The display in which the helper will be 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="a00132.html">scim_helper_manager.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>
