<!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::DebugOutput 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="a00018.html">DebugOutput</a>
</div>
</div>
<div class="contents">
<h1>scim::DebugOutput Class Reference</h1><!-- doxytag: class="scim::DebugOutput" -->The class to filter and redirect the debug messages.
<a href="#_details">More...</a>
<p>
<code>#include <scim_debug.h></code>
<p>
<p>
<a href="a00231.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="a00018.html#5649f8232f5fd44a2874670a4b455f5b">DebugOutput</a> (<a class="el" href="a00157.html#984ae8c1b52846cf538b7f936193d590">uint32</a> mask=SCIM_DEBUG_AllMask, <a class="el" href="a00157.html#984ae8c1b52846cf538b7f936193d590">uint32</a> verbose=1)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#5649f8232f5fd44a2874670a4b455f5b"></a><br></td></tr>
<tr><td class="memTemplParams" nowrap colspan="2">template<typename T > </td></tr>
<tr><td class="memTemplItemLeft" nowrap align="right" valign="top">const <a class="el" href="a00018.html">DebugOutput</a> & </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a00018.html#62fa5633022510ebf395ce28c4fd7526">operator<<</a> (const T &t) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A template stream output operator. <a href="#62fa5633022510ebf395ce28c4fd7526"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00018.html#a8e8af7341652ba2e988f5383833d83a">enable_debug</a> (<a class="el" href="a00157.html#984ae8c1b52846cf538b7f936193d590">uint32</a> debug)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The global method to enable the debug output. <a href="#a8e8af7341652ba2e988f5383833d83a"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00018.html#b60b3a2e7b127d9bf7823432bc112484">enable_debug_by_name</a> (const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> &debug)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The global method to enable the debug output by their names. <a href="#b60b3a2e7b127d9bf7823432bc112484"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00018.html#c3ae53e020a39742d20a25d73768497d">disable_debug</a> (<a class="el" href="a00157.html#984ae8c1b52846cf538b7f936193d590">uint32</a> debug)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Disable the debug type indicated by the given mask. <a href="#c3ae53e020a39742d20a25d73768497d"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00018.html#b02c6ae51658875d862611ef1f2b56da">disable_debug_by_name</a> (const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> &debug)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Disable the debug type indicated by the given name. <a href="#b02c6ae51658875d862611ef1f2b56da"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00018.html#ac053ac9c8b1140f52d2f252031d5241">set_verbose_level</a> (<a class="el" href="a00157.html#984ae8c1b52846cf538b7f936193d590">uint32</a> verbose)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the debug verbose level. <a href="#ac053ac9c8b1140f52d2f252031d5241"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00018.html#b062e9f89d58378b83bf769cdac4700e">set_output</a> (const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> &file)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the debug output file. <a href="#b062e9f89d58378b83bf769cdac4700e"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00018.html#aaa0b0de4a4948bb3971707318772ab1">serial_number</a> ()</td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
The class to filter and redirect the debug messages. <hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="5649f8232f5fd44a2874670a4b455f5b"></a><!-- doxytag: member="scim::DebugOutput::DebugOutput" ref="5649f8232f5fd44a2874670a4b455f5b" args="(uint32 mask=SCIM_DEBUG_AllMask, uint32 verbose=1)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">scim::DebugOutput::DebugOutput </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00157.html#984ae8c1b52846cf538b7f936193d590">uint32</a> </td>
<td class="paramname"> <em>mask</em> = <code>SCIM_DEBUG_AllMask</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="a00157.html#984ae8c1b52846cf538b7f936193d590">uint32</a> </td>
<td class="paramname"> <em>verbose</em> = <code>1</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></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>mask</em> </td><td>- the debug filter mask. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>verbose</em> </td><td>- the verbose level of the debug message. </td></tr>
</table>
</dl>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="62fa5633022510ebf395ce28c4fd7526"></a><!-- doxytag: member="scim::DebugOutput::operator<<" ref="62fa5633022510ebf395ce28c4fd7526" args="(const T &t) const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T > </div>
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="a00018.html">DebugOutput</a>& scim::DebugOutput::operator<< </td>
<td>(</td>
<td class="paramtype">const T & </td>
<td class="paramname"> <em>t</em> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
A template stream output operator.
<p>
All kinds of data and variables can be output via <a class="el" href="a00018.html" title="The class to filter and redirect the debug messages.">DebugOutput</a> by this operator.
</div>
</div><p>
<a class="anchor" name="a8e8af7341652ba2e988f5383833d83a"></a><!-- doxytag: member="scim::DebugOutput::enable_debug" ref="a8e8af7341652ba2e988f5383833d83a" args="(uint32 debug)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static void scim::DebugOutput::enable_debug </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00157.html#984ae8c1b52846cf538b7f936193d590">uint32</a> </td>
<td class="paramname"> <em>debug</em> </td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
The global method to enable the debug output.
<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>debug</em> </td><td>- the mask to indicate which kind of debug should be enabled. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="b60b3a2e7b127d9bf7823432bc112484"></a><!-- doxytag: member="scim::DebugOutput::enable_debug_by_name" ref="b60b3a2e7b127d9bf7823432bc112484" args="(const String &debug)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static void scim::DebugOutput::enable_debug_by_name </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> & </td>
<td class="paramname"> <em>debug</em> </td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
The global method to enable the debug output by their names.
<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>debug</em> </td><td>- the name of the debug type to be enabled. The valid names are: all, main, config, imengine, backend, frontend, module, utility, iconv, lookuptable, socket. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="c3ae53e020a39742d20a25d73768497d"></a><!-- doxytag: member="scim::DebugOutput::disable_debug" ref="c3ae53e020a39742d20a25d73768497d" args="(uint32 debug)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static void scim::DebugOutput::disable_debug </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00157.html#984ae8c1b52846cf538b7f936193d590">uint32</a> </td>
<td class="paramname"> <em>debug</em> </td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Disable the debug type indicated by the given mask.
<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>debug</em> </td><td>- the mask of the debug type to be disabled. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="b02c6ae51658875d862611ef1f2b56da"></a><!-- doxytag: member="scim::DebugOutput::disable_debug_by_name" ref="b02c6ae51658875d862611ef1f2b56da" args="(const String &debug)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static void scim::DebugOutput::disable_debug_by_name </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> & </td>
<td class="paramname"> <em>debug</em> </td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Disable the debug type indicated by the given name.
<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>debug</em> </td><td>- the name of the debug type to be disabled. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="ac053ac9c8b1140f52d2f252031d5241"></a><!-- doxytag: member="scim::DebugOutput::set_verbose_level" ref="ac053ac9c8b1140f52d2f252031d5241" args="(uint32 verbose)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static void scim::DebugOutput::set_verbose_level </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00157.html#984ae8c1b52846cf538b7f936193d590">uint32</a> </td>
<td class="paramname"> <em>verbose</em> </td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set the debug verbose level.
<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>verbose</em> </td><td>- the debug verbose level, 0 means no debug output. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="b062e9f89d58378b83bf769cdac4700e"></a><!-- doxytag: member="scim::DebugOutput::set_output" ref="b062e9f89d58378b83bf769cdac4700e" args="(const String &file)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static void scim::DebugOutput::set_output </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> & </td>
<td class="paramname"> <em>file</em> </td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set the debug output file.
<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>file</em> </td><td>- the file to store the debug output. If equal to "stderr" or "cerr" then the debug output will be set to std:cerr. If equal to "stdout" or "cout" then the debug output will be set to std::cout. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="aaa0b0de4a4948bb3971707318772ab1"></a><!-- doxytag: member="scim::DebugOutput::serial_number" ref="aaa0b0de4a4948bb3971707318772ab1" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> scim::DebugOutput::serial_number </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="a00122.html">scim_debug.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>
