<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>incron: IncronTab Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">incron
 <span id="projectnumber">0.5.10</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- Generated by Doxygen 1.7.5.1 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<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 id="navrow2" class="tabs2">
<ul class="tablist">
<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="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-static-methods">Static Public Member Functions</a> |
<a href="#pro-attribs">Protected Attributes</a> </div>
<div class="headertitle">
<div class="title">IncronTab Class Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="IncronTab" -->
<p>Incron table class.
<a href="classIncronTab.html#details">More...</a></p>
<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></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classIncronTab.html#a9ff09c9b375176fc2b96b2e9c523e037">IncronTab</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#a9ff09c9b375176fc2b96b2e9c523e037"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classIncronTab.html#a4ec208d89d7b11503ebfe54391a59b81">~IncronTab</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#a4ec208d89d7b11503ebfe54391a59b81"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classIncronTab.html#af54355a6241c05ac955486d47f18fb50">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="#af54355a6241c05ac955486d47f18fb50"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classIncronTab.html#a5fc3d14ccb6a17b4c19c3df04ea979b8">Clear</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Removes all entries. <a href="#a5fc3d14ccb6a17b4c19c3df04ea979b8"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classIncronTab.html#aee67b6f3d9202fe659ca9f48ea316669">IsEmpty</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Checks whether the table is empty. <a href="#aee67b6f3d9202fe659ca9f48ea316669"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classIncronTab.html#a73b95d66e3feed3d7c8cb6ee2cd4dcc0">GetCount</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the count of entries. <a href="#a73b95d66e3feed3d7c8cb6ee2cd4dcc0"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classIncronTabEntry.html">IncronTabEntry</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classIncronTab.html#ab2b3ef9db60949d666a6316b4698074a">GetEntry</a> (int index)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns an entry. <a href="#ab2b3ef9db60949d666a6316b4698074a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classIncronTab.html#a3e15c2a29bda1cd4118359736a75e905">Load</a> (const std::string &rPath)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Loads the table. <a href="#a3e15c2a29bda1cd4118359736a75e905"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classIncronTab.html#a6bb007c88e2efb823b96536b54bcb05b">Save</a> (const std::string &rPath)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Saves the table. <a href="#a6bb007c88e2efb823b96536b54bcb05b"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classIncronTab.html#a887ffc0116f2e892178db882420e5aaa">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="#a887ffc0116f2e892178db882420e5aaa"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classIncronTab.html#a41994a129d3e38a2f032318d53f4e888">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="#a41994a129d3e38a2f032318d53f4e888"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classIncronTab.html#a55f610c3405db0d48d0a759e3180cf7b">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="#a55f610c3405db0d48d0a759e3180cf7b"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" 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#afc0c07b696470b29c2173e4dcf313bc7">m_tab</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">incron table <a href="#afc0c07b696470b29c2173e4dcf313bc7"></a><br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Incron table class. </p>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a9ff09c9b375176fc2b96b2e9c523e037"></a><!-- doxytag: member="IncronTab::IncronTab" ref="a9ff09c9b375176fc2b96b2e9c523e037" 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>
<a class="anchor" id="a4ec208d89d7b11503ebfe54391a59b81"></a><!-- doxytag: member="IncronTab::~IncronTab" ref="a4ec208d89d7b11503ebfe54391a59b81" 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>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="af54355a6241c05ac955486d47f18fb50"></a><!-- doxytag: member="IncronTab::Add" ref="af54355a6241c05ac955486d47f18fb50" 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><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">rEntry</td><td>table entry </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a887ffc0116f2e892178db882420e5aaa"></a><!-- doxytag: member="IncronTab::CheckUser" ref="a887ffc0116f2e892178db882420e5aaa" 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><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">rUser</td><td>user name </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true = permission OK, false = otherwise </dd></dl>
</div>
</div>
<a class="anchor" id="a5fc3d14ccb6a17b4c19c3df04ea979b8"></a><!-- doxytag: member="IncronTab::Clear" ref="a5fc3d14ccb6a17b4c19c3df04ea979b8" 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>
<a class="anchor" id="a73b95d66e3feed3d7c8cb6ee2cd4dcc0"></a><!-- doxytag: member="IncronTab::GetCount" ref="a73b95d66e3feed3d7c8cb6ee2cd4dcc0" 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"><dt><b>Returns:</b></dt><dd>count of entries </dd></dl>
</div>
</div>
<a class="anchor" id="ab2b3ef9db60949d666a6316b4698074a"></a><!-- doxytag: member="IncronTab::GetEntry" ref="ab2b3ef9db60949d666a6316b4698074a" 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"><dt><b>Returns:</b></dt><dd>reference to the entry for the given index</dd></dl>
<dl class="attention"><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>
<a class="anchor" id="a55f610c3405db0d48d0a759e3180cf7b"></a><!-- doxytag: member="IncronTab::GetSystemTablePath" ref="a55f610c3405db0d48d0a759e3180cf7b" 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><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">rName</td><td>table name (pseudouser) </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>path to the table file</dd></dl>
<dl class="attention"><dt><b>Attention:</b></dt><dd>No tests (existence, permission etc.) are done. </dd></dl>
</div>
</div>
<a class="anchor" id="a41994a129d3e38a2f032318d53f4e888"></a><!-- doxytag: member="IncronTab::GetUserTablePath" ref="a41994a129d3e38a2f032318d53f4e888" 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><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">rUser</td><td>user name </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>path to the table file</dd></dl>
<dl class="attention"><dt><b>Attention:</b></dt><dd>No tests (existence, permission etc.) are done. </dd></dl>
</div>
</div>
<a class="anchor" id="aee67b6f3d9202fe659ca9f48ea316669"></a><!-- doxytag: member="IncronTab::IsEmpty" ref="aee67b6f3d9202fe659ca9f48ea316669" 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"><dt><b>Returns:</b></dt><dd>true = empty, false = otherwise </dd></dl>
</div>
</div>
<a class="anchor" id="a3e15c2a29bda1cd4118359736a75e905"></a><!-- doxytag: member="IncronTab::Load" ref="a3e15c2a29bda1cd4118359736a75e905" 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><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">rPath</td><td>path to a source table file </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true = success, false = failure </dd></dl>
</div>
</div>
<a class="anchor" id="a6bb007c88e2efb823b96536b54bcb05b"></a><!-- doxytag: member="IncronTab::Save" ref="a6bb007c88e2efb823b96536b54bcb05b" 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><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">rPath</td><td>path to a destination table file </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true = success, false = failure </dd></dl>
</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="afc0c07b696470b29c2173e4dcf313bc7"></a><!-- doxytag: member="IncronTab::m_tab" ref="afc0c07b696470b29c2173e4dcf313bc7" 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#afc0c07b696470b29c2173e4dcf313bc7">IncronTab::m_tab</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>incron table </p>
</div>
</div>
<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>
<li><a class="el" href="incrontab_8cpp.html">incrontab.cpp</a></li>
</ul>
</div>
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.7.5.1
</small></address>
</body>
</html>
distrib
>
Mageia
>
7
>
armv7hl
>
media
>
core-release
>
by-pkgid
>
9a9cef5a3a2b597a6e4663b51cfdf030
>
files
>
35
