<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>incron: IncronTab 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.6 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</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="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>IncronTab Class Reference</h1><!-- doxytag: class="IncronTab" -->Incron table class.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="incrontab_8h-source.html">incrontab.h</a>></code>
<p>
<p>
<a href="classIncronTab-members.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="classIncronTab.html#9ff09c9b375176fc2b96b2e9c523e037">IncronTab</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#9ff09c9b375176fc2b96b2e9c523e037"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classIncronTab.html#4ec208d89d7b11503ebfe54391a59b81">~IncronTab</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#4ec208d89d7b11503ebfe54391a59b81"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classIncronTab.html#f54355a6241c05ac955486d47f18fb50">Add</a> (const <a class="el" href="classIncronTabEntry.html">IncronTabEntry</a> &rEntry)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Add an entry to the table. <a href="#f54355a6241c05ac955486d47f18fb50"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classIncronTab.html#5fc3d14ccb6a17b4c19c3df04ea979b8">Clear</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Removes all entries. <a href="#5fc3d14ccb6a17b4c19c3df04ea979b8"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classIncronTab.html#ee67b6f3d9202fe659ca9f48ea316669">IsEmpty</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Checks whether the table is empty. <a href="#ee67b6f3d9202fe659ca9f48ea316669"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classIncronTab.html#73b95d66e3feed3d7c8cb6ee2cd4dcc0">GetCount</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the count of entries. <a href="#73b95d66e3feed3d7c8cb6ee2cd4dcc0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classIncronTabEntry.html">IncronTabEntry</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classIncronTab.html#b2b3ef9db60949d666a6316b4698074a">GetEntry</a> (int index)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns an entry. <a href="#b2b3ef9db60949d666a6316b4698074a"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classIncronTab.html#3e15c2a29bda1cd4118359736a75e905">Load</a> (const std::string &rPath)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Loads the table. <a href="#3e15c2a29bda1cd4118359736a75e905"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classIncronTab.html#6bb007c88e2efb823b96536b54bcb05b">Save</a> (const std::string &rPath)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Saves the table. <a href="#6bb007c88e2efb823b96536b54bcb05b"></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 bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classIncronTab.html#887ffc0116f2e892178db882420e5aaa">CheckUser</a> (const std::string &rUser)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Checks whether an user has permission to use incron. <a href="#887ffc0116f2e892178db882420e5aaa"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classIncronTab.html#41994a129d3e38a2f032318d53f4e888">GetUserTablePath</a> (const std::string &rUser)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Composes a path to an user incron table file. <a href="#41994a129d3e38a2f032318d53f4e888"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classIncronTab.html#55f610c3405db0d48d0a759e3180cf7b">GetSystemTablePath</a> (const std::string &rName)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Composes a path to a system incron table file. <a href="#55f610c3405db0d48d0a759e3180cf7b"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">std::deque< <a class="el" href="classIncronTabEntry.html">IncronTabEntry</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classIncronTab.html#fc0c07b696470b29c2173e4dcf313bc7">m_tab</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">incron table <a href="#fc0c07b696470b29c2173e4dcf313bc7"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Incron table class. <hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="9ff09c9b375176fc2b96b2e9c523e037"></a><!-- doxytag: member="IncronTab::IncronTab" ref="9ff09c9b375176fc2b96b2e9c523e037" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">IncronTab::IncronTab </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Constructor.
<p>
</div>
</div><p>
<a class="anchor" name="4ec208d89d7b11503ebfe54391a59b81"></a><!-- doxytag: member="IncronTab::~IncronTab" ref="4ec208d89d7b11503ebfe54391a59b81" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">IncronTab::~IncronTab </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Destructor.
<p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="f54355a6241c05ac955486d47f18fb50"></a><!-- doxytag: member="IncronTab::Add" ref="f54355a6241c05ac955486d47f18fb50" args="(const IncronTabEntry &rEntry)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void IncronTab::Add </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classIncronTabEntry.html">IncronTabEntry</a> & </td>
<td class="paramname"> <em>rEntry</em> </td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Add an entry to the table.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>rEntry</em> </td><td>table entry </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="5fc3d14ccb6a17b4c19c3df04ea979b8"></a><!-- doxytag: member="IncronTab::Clear" ref="5fc3d14ccb6a17b4c19c3df04ea979b8" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void IncronTab::Clear </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Removes all entries.
<p>
</div>
</div><p>
<a class="anchor" name="ee67b6f3d9202fe659ca9f48ea316669"></a><!-- doxytag: member="IncronTab::IsEmpty" ref="ee67b6f3d9202fe659ca9f48ea316669" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool IncronTab::IsEmpty </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Checks whether the table is empty.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>true = empty, false = otherwise </dd></dl>
</div>
</div><p>
<a class="anchor" name="73b95d66e3feed3d7c8cb6ee2cd4dcc0"></a><!-- doxytag: member="IncronTab::GetCount" ref="73b95d66e3feed3d7c8cb6ee2cd4dcc0" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int IncronTab::GetCount </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns the count of entries.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>count of entries </dd></dl>
</div>
</div><p>
<a class="anchor" name="b2b3ef9db60949d666a6316b4698074a"></a><!-- doxytag: member="IncronTab::GetEntry" ref="b2b3ef9db60949d666a6316b4698074a" args="(int index)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classIncronTabEntry.html">IncronTabEntry</a>& IncronTab::GetEntry </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>index</em> </td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns an entry.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>reference to the entry for the given index</dd></dl>
<dl class="attention" compact><dt><b>Attention:</b></dt><dd>This method doesn't test index bounds. If you pass an invalid value the program may crash and/or behave unpredictible way! </dd></dl>
</div>
</div><p>
<a class="anchor" name="3e15c2a29bda1cd4118359736a75e905"></a><!-- doxytag: member="IncronTab::Load" ref="3e15c2a29bda1cd4118359736a75e905" args="(const std::string &rPath)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool IncronTab::Load </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"> <em>rPath</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Loads the table.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>rPath</em> </td><td>path to a source table file </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>true = success, false = failure </dd></dl>
</div>
</div><p>
<a class="anchor" name="6bb007c88e2efb823b96536b54bcb05b"></a><!-- doxytag: member="IncronTab::Save" ref="6bb007c88e2efb823b96536b54bcb05b" args="(const std::string &rPath)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool IncronTab::Save </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"> <em>rPath</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Saves the table.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>rPath</em> </td><td>path to a destination table file </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>true = success, false = failure </dd></dl>
</div>
</div><p>
<a class="anchor" name="887ffc0116f2e892178db882420e5aaa"></a><!-- doxytag: member="IncronTab::CheckUser" ref="887ffc0116f2e892178db882420e5aaa" args="(const std::string &rUser)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool IncronTab::CheckUser </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"> <em>rUser</em> </td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Checks whether an user has permission to use incron.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>rUser</em> </td><td>user name </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>true = permission OK, false = otherwise </dd></dl>
</div>
</div><p>
<a class="anchor" name="41994a129d3e38a2f032318d53f4e888"></a><!-- doxytag: member="IncronTab::GetUserTablePath" ref="41994a129d3e38a2f032318d53f4e888" args="(const std::string &rUser)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string IncronTab::GetUserTablePath </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"> <em>rUser</em> </td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Composes a path to an user incron table file.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>rUser</em> </td><td>user name </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>path to the table file</dd></dl>
<dl class="attention" compact><dt><b>Attention:</b></dt><dd>No tests (existence, permission etc.) are done. </dd></dl>
</div>
</div><p>
<a class="anchor" name="55f610c3405db0d48d0a759e3180cf7b"></a><!-- doxytag: member="IncronTab::GetSystemTablePath" ref="55f610c3405db0d48d0a759e3180cf7b" args="(const std::string &rName)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string IncronTab::GetSystemTablePath </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"> <em>rName</em> </td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Composes a path to a system incron table file.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>rName</em> </td><td>table name (pseudouser) </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>path to the table file</dd></dl>
<dl class="attention" compact><dt><b>Attention:</b></dt><dd>No tests (existence, permission etc.) are done. </dd></dl>
</div>
</div><p>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="fc0c07b696470b29c2173e4dcf313bc7"></a><!-- doxytag: member="IncronTab::m_tab" ref="fc0c07b696470b29c2173e4dcf313bc7" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::deque<<a class="el" href="classIncronTabEntry.html">IncronTabEntry</a>> <a class="el" href="classIncronTab.html#fc0c07b696470b29c2173e4dcf313bc7">IncronTab::m_tab</a><code> [protected]</code> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
incron table
<p>
</div>
</div><p>
<hr>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="incrontab_8h-source.html">incrontab.h</a><li><a class="el" href="incrontab_8cpp.html">incrontab.cpp</a></ul>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Sun Jun 21 22:27:24 2009 for incron by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
</body>
</html>
distrib
>
Mandriva
>
2010.0
>
i586
>
media
>
contrib-release
>
by-pkgid
>
a964702347d726c5f8ba742f8b9d5908
>
files
>
30
