LogDoctor/docs/html/namespacePrintSec.html

348 lines
16 KiB
HTML
Raw Normal View History

2023-04-30 21:48:24 +02:00
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
2024-02-16 21:59:07 +01:00
<meta name="generator" content="Doxygen 1.10.0"/>
2023-04-30 21:48:24 +02:00
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>LogDoctor: PrintSec Namespace Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
2024-02-16 21:59:07 +01:00
<script type="text/javascript" src="clipboard.js"></script>
<script type="text/javascript" src="cookie.js"></script>
2023-04-30 21:48:24 +02:00
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr id="projectrow">
<td id="projectlogo"><img alt="Logo" src="dox_logo.png"/></td>
<td id="projectalign">
2024-02-16 22:18:16 +01:00
<div id="projectname">LogDoctor<span id="projectnumber">&#160;4.00</span>
2023-04-30 21:48:24 +02:00
</div>
<div id="projectbrief">Parse Apache2/Nginx/IIS logs and view dinamically generated statistics</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
2024-02-16 21:59:07 +01:00
<!-- Generated by Doxygen 1.10.0 -->
2023-04-30 21:48:24 +02:00
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
2024-02-16 21:59:07 +01:00
$(function() { init_search(); });
2023-04-30 21:48:24 +02:00
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">PrintSec Namespace Reference</div></div>
</div><!--header-->
<div class="contents">
<p><a class="el" href="namespacePrintSec.html" title="PrintSec.">PrintSec</a>.
2024-02-16 21:59:07 +01:00
<a href="#details">More...</a></p>
2023-04-30 21:48:24 +02:00
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
2024-02-16 21:59:07 +01:00
<tr class="memitem:a403edb539662a165dd79f5756ded42e4" id="r_a403edb539662a165dd79f5756ded42e4"><td class="memItemLeft" align="right" valign="top">QString&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a403edb539662a165dd79f5756ded42e4">printableSize</a> (const size_t bytes) noexcept</td></tr>
<tr class="memdesc:a403edb539662a165dd79f5756ded42e4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Formats the size including the suffix, for display purposes. <br /></td></tr>
<tr class="separator:a403edb539662a165dd79f5756ded42e4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4a6a0bc389a6ffb47bfcc6c9dbb70602" id="r_a4a6a0bc389a6ffb47bfcc6c9dbb70602"><td class="memItemLeft" align="right" valign="top">QString&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a4a6a0bc389a6ffb47bfcc6c9dbb70602">printableSpeed</a> (const double bytes, const double seconds) noexcept</td></tr>
<tr class="memdesc:a4a6a0bc389a6ffb47bfcc6c9dbb70602"><td class="mdescLeft">&#160;</td><td class="mdescRight">Formats the speed including the suffix, for display purposes. <br /></td></tr>
<tr class="separator:a4a6a0bc389a6ffb47bfcc6c9dbb70602"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aff2f11c41388c7bf69dd356e0c8ca684" id="r_aff2f11c41388c7bf69dd356e0c8ca684"><td class="memItemLeft" align="right" valign="top">QString&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aff2f11c41388c7bf69dd356e0c8ca684">printableTime</a> (const unsigned seconds) noexcept</td></tr>
<tr class="memdesc:aff2f11c41388c7bf69dd356e0c8ca684"><td class="mdescLeft">&#160;</td><td class="mdescRight">Formats the time, for display purposes. <br /></td></tr>
<tr class="separator:aff2f11c41388c7bf69dd356e0c8ca684"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4effe535f84fd9f38c2103ff574def5c" id="r_a4effe535f84fd9f38c2103ff574def5c"><td class="memItemLeft" align="right" valign="top">QString&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a4effe535f84fd9f38c2103ff574def5c">printableTime</a> (const int hour, const int minute, const int second) noexcept</td></tr>
<tr class="memdesc:a4effe535f84fd9f38c2103ff574def5c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a string of the given time in the format HH:MM:SS. <br /></td></tr>
<tr class="separator:a4effe535f84fd9f38c2103ff574def5c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aafb3b1700d8287c148f731c8e996ce32" id="r_aafb3b1700d8287c148f731c8e996ce32"><td class="memItemLeft" align="right" valign="top">QString&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aafb3b1700d8287c148f731c8e996ce32">printableDate</a> (const int year, const int month, const int day) noexcept</td></tr>
<tr class="memdesc:aafb3b1700d8287c148f731c8e996ce32"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a string of the given date in the format YYYY-MM-DD. <br /></td></tr>
<tr class="separator:aafb3b1700d8287c148f731c8e996ce32"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4740c8b66e8608489309d8aa11826d14" id="r_a4740c8b66e8608489309d8aa11826d14"><td class="memItemLeft" align="right" valign="top">QString&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a4740c8b66e8608489309d8aa11826d14">printableBool</a> (const int value) noexcept</td></tr>
<tr class="memdesc:a4740c8b66e8608489309d8aa11826d14"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a string corresponding to the given value. <br /></td></tr>
<tr class="separator:a4740c8b66e8608489309d8aa11826d14"><td class="memSeparator" colspan="2">&#160;</td></tr>
2023-04-30 21:48:24 +02:00
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p><a class="el" href="namespacePrintSec.html" title="PrintSec.">PrintSec</a>. </p>
<p>Utilities to have printable stuff </p>
</div><h2 class="groupheader">Function Documentation</h2>
2024-02-16 21:59:07 +01:00
<a id="a4740c8b66e8608489309d8aa11826d14" name="a4740c8b66e8608489309d8aa11826d14"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4740c8b66e8608489309d8aa11826d14">&#9670;&#160;</a></span>printableBool()</h2>
2023-04-30 21:48:24 +02:00
<div class="memitem">
<div class="memproto">
2024-02-16 21:59:07 +01:00
<table class="mlabels">
<tr>
<td class="mlabels-left">
2023-04-30 21:48:24 +02:00
<table class="memname">
<tr>
2023-10-22 17:46:43 +02:00
<td class="memname">QString PrintSec::printableBool </td>
2023-04-30 21:48:24 +02:00
<td>(</td>
2024-02-16 21:59:07 +01:00
<td class="paramtype">const int</td> <td class="paramname"><span class="paramname"><em>value</em></span></td><td>)</td>
2023-04-30 21:48:24 +02:00
<td></td>
</tr>
</table>
2024-02-16 21:59:07 +01:00
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
2023-04-30 21:48:24 +02:00
</div><div class="memdoc">
<p>Returns a string corresponding to the given value. </p>
<p>Used to convert numeric booleans [0,1] to string [FALSE,TRUE] </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">value</td><td>The value to convert </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The corresponding printable string </dd></dl>
</div>
</div>
2024-02-16 21:59:07 +01:00
<a id="aafb3b1700d8287c148f731c8e996ce32" name="aafb3b1700d8287c148f731c8e996ce32"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aafb3b1700d8287c148f731c8e996ce32">&#9670;&#160;</a></span>printableDate()</h2>
2023-04-30 21:48:24 +02:00
<div class="memitem">
<div class="memproto">
2024-02-16 21:59:07 +01:00
<table class="mlabels">
<tr>
<td class="mlabels-left">
2023-04-30 21:48:24 +02:00
<table class="memname">
<tr>
2023-10-22 17:46:43 +02:00
<td class="memname">QString PrintSec::printableDate </td>
2023-04-30 21:48:24 +02:00
<td>(</td>
2024-02-16 21:59:07 +01:00
<td class="paramtype">const int</td> <td class="paramname"><span class="paramname"><em>year</em>, </span></td>
2023-04-30 21:48:24 +02:00
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
2024-02-16 21:59:07 +01:00
<td class="paramtype">const int</td> <td class="paramname"><span class="paramname"><em>month</em>, </span></td>
2023-04-30 21:48:24 +02:00
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
2024-02-16 21:59:07 +01:00
<td class="paramtype">const int</td> <td class="paramname"><span class="paramname"><em>day</em></span>&#160;)</td>
2023-04-30 21:48:24 +02:00
</tr>
</table>
2024-02-16 21:59:07 +01:00
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
2023-04-30 21:48:24 +02:00
</div><div class="memdoc">
<p>Returns a string of the given date in the format YYYY-MM-DD. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">year</td><td>The year (4 digits number) </td></tr>
<tr><td class="paramname">month</td><td>The month </td></tr>
<tr><td class="paramname">day</td><td>The day </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The printable date </dd></dl>
</div>
</div>
2024-02-16 21:59:07 +01:00
<a id="a403edb539662a165dd79f5756ded42e4" name="a403edb539662a165dd79f5756ded42e4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a403edb539662a165dd79f5756ded42e4">&#9670;&#160;</a></span>printableSize()</h2>
2023-04-30 21:48:24 +02:00
<div class="memitem">
<div class="memproto">
2024-02-16 21:59:07 +01:00
<table class="mlabels">
<tr>
<td class="mlabels-left">
2023-04-30 21:48:24 +02:00
<table class="memname">
<tr>
2023-10-22 17:46:43 +02:00
<td class="memname">QString PrintSec::printableSize </td>
2023-04-30 21:48:24 +02:00
<td>(</td>
2024-02-16 21:59:07 +01:00
<td class="paramtype">const size_t</td> <td class="paramname"><span class="paramname"><em>bytes</em></span></td><td>)</td>
2023-04-30 21:48:24 +02:00
<td></td>
</tr>
</table>
2024-02-16 21:59:07 +01:00
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
2023-04-30 21:48:24 +02:00
</div><div class="memdoc">
<p>Formats the size including the suffix, for display purposes. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">bytes</td><td>The size in bytes </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The string to be displayed </dd></dl>
</div>
</div>
2024-02-16 21:59:07 +01:00
<a id="a4a6a0bc389a6ffb47bfcc6c9dbb70602" name="a4a6a0bc389a6ffb47bfcc6c9dbb70602"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4a6a0bc389a6ffb47bfcc6c9dbb70602">&#9670;&#160;</a></span>printableSpeed()</h2>
2023-04-30 21:48:24 +02:00
<div class="memitem">
<div class="memproto">
2024-02-16 21:59:07 +01:00
<table class="mlabels">
<tr>
<td class="mlabels-left">
2023-04-30 21:48:24 +02:00
<table class="memname">
<tr>
2023-10-22 17:46:43 +02:00
<td class="memname">QString PrintSec::printableSpeed </td>
2023-04-30 21:48:24 +02:00
<td>(</td>
2024-02-16 21:59:07 +01:00
<td class="paramtype">const double</td> <td class="paramname"><span class="paramname"><em>bytes</em>, </span></td>
2023-04-30 21:48:24 +02:00
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
2024-02-16 21:59:07 +01:00
<td class="paramtype">const double</td> <td class="paramname"><span class="paramname"><em>seconds</em></span>&#160;)</td>
2023-04-30 21:48:24 +02:00
</tr>
</table>
2024-02-16 21:59:07 +01:00
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
2023-04-30 21:48:24 +02:00
</div><div class="memdoc">
<p>Formats the speed including the suffix, for display purposes. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">bytes</td><td>The size in bytes </td></tr>
<tr><td class="paramname">seconds</td><td>The number of seconds </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The string to be displayed </dd></dl>
</div>
</div>
2024-02-16 21:59:07 +01:00
<a id="a4effe535f84fd9f38c2103ff574def5c" name="a4effe535f84fd9f38c2103ff574def5c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4effe535f84fd9f38c2103ff574def5c">&#9670;&#160;</a></span>printableTime() <span class="overload">[1/2]</span></h2>
2023-04-30 21:48:24 +02:00
<div class="memitem">
<div class="memproto">
2024-02-16 21:59:07 +01:00
<table class="mlabels">
<tr>
<td class="mlabels-left">
2023-04-30 21:48:24 +02:00
<table class="memname">
<tr>
2023-10-22 17:46:43 +02:00
<td class="memname">QString PrintSec::printableTime </td>
2023-04-30 21:48:24 +02:00
<td>(</td>
2024-02-16 21:59:07 +01:00
<td class="paramtype">const int</td> <td class="paramname"><span class="paramname"><em>hour</em>, </span></td>
2023-04-30 21:48:24 +02:00
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
2024-02-16 21:59:07 +01:00
<td class="paramtype">const int</td> <td class="paramname"><span class="paramname"><em>minute</em>, </span></td>
2023-04-30 21:48:24 +02:00
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
2024-02-16 21:59:07 +01:00
<td class="paramtype">const int</td> <td class="paramname"><span class="paramname"><em>second</em></span>&#160;)</td>
2023-04-30 21:48:24 +02:00
</tr>
</table>
2024-02-16 21:59:07 +01:00
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
2023-04-30 21:48:24 +02:00
</div><div class="memdoc">
<p>Returns a string of the given time in the format HH:MM:SS. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">hour</td><td>The hour </td></tr>
<tr><td class="paramname">minut</td><td>The minute </td></tr>
<tr><td class="paramname">second</td><td>The second </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The printable time </dd></dl>
</div>
</div>
2024-02-16 21:59:07 +01:00
<a id="aff2f11c41388c7bf69dd356e0c8ca684" name="aff2f11c41388c7bf69dd356e0c8ca684"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aff2f11c41388c7bf69dd356e0c8ca684">&#9670;&#160;</a></span>printableTime() <span class="overload">[2/2]</span></h2>
2023-04-30 21:48:24 +02:00
<div class="memitem">
<div class="memproto">
2024-02-16 21:59:07 +01:00
<table class="mlabels">
<tr>
<td class="mlabels-left">
2023-04-30 21:48:24 +02:00
<table class="memname">
<tr>
2023-10-22 17:46:43 +02:00
<td class="memname">QString PrintSec::printableTime </td>
2023-04-30 21:48:24 +02:00
<td>(</td>
2024-02-16 21:59:07 +01:00
<td class="paramtype">const unsigned</td> <td class="paramname"><span class="paramname"><em>seconds</em></span></td><td>)</td>
2023-04-30 21:48:24 +02:00
<td></td>
</tr>
</table>
2024-02-16 21:59:07 +01:00
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
2023-04-30 21:48:24 +02:00
</div><div class="memdoc">
<p>Formats the time, for display purposes. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">seconds</td><td>The number of seconds </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The string to be displayed </dd></dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
2024-02-16 21:59:07 +01:00
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.10.0
2023-04-30 21:48:24 +02:00
</small></address>
</body>
</html>