detectors/aare
25
0
Fork 0
mirror of https://github.com/slsdetectorgroup/aare.git synced 2025-06-12 15:27:13 +02:00
Code Issues Actions Packages Releases Activity

setup doxygen and clang-uml files

Browse Source
This commit is contained in:
Bechir Braham
2024-04-11 17:20:34 +02:00
parent 111b421476
commit 2ebbd0d7cd
640 changed files with 77235 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

278
docs/html/logger_8hpp.html Normal file
View File

@ -0,0 +1,278 @@
<!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"/>
<meta name="generator" content="Doxygen 1.9.7"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>AARE: utils/include/aare/utils/logger.hpp File 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>
<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="projectalign">
<div id="projectname">AARE
</div>
<div id="projectbrief">Data analysis library for PSI hybrid detectors</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.7 -->
<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');
$(document).ready(function() { init_search(); });
});
/* @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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_cbdb8362360e11eafe2fa3bc74cf0ffd.html">utils</a></li><li class="navelem"><a class="el" href="dir_b4cad7074c2c537630e3aa48c3ef8dec.html">include</a></li><li class="navelem"><a class="el" href="dir_ccaeb5e2c6cdb3d1ee8d63160775ad35.html">aare</a></li><li class="navelem"><a class="el" href="dir_0c0f18a4d4157d5e4e3aed054d9d8710.html">utils</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Data Structures</a> &#124;
<a href="#namespaces">Namespaces</a> &#124;
<a href="#define-members">Macros</a> &#124;
<a href="#enum-members">Enumerations</a> &#124;
<a href="#func-members">Functions</a> &#124;
<a href="#var-members">Variables</a> </div>
<div class="headertitle"><div class="title">logger.hpp File Reference</div></div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &lt;filesystem&gt;</code><br />
<code>#include &lt;fstream&gt;</code><br />
<code>#include &lt;iostream&gt;</code><br />
<code>#include &lt;map&gt;</code><br />
<code>#include &lt;vector&gt;</code><br />
</div>
<p><a href="logger_8hpp_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classaare_1_1logger_1_1Logger.html">aare::logger::Logger</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="namespaces" name="namespaces"></a>
Namespaces</h2></td></tr>
<tr class="memitem:namespaceaare"><td class="memItemLeft" align="right" valign="top">namespace &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceaare.html">aare</a></td></tr>
<tr class="memdesc:namespaceaare"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="classaare_1_1Frame.html">Frame</a> class to represent a single frame of data model class should be able to work with streams coming from files or network. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:namespaceaare_1_1logger"><td class="memItemLeft" align="right" valign="top">namespace &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceaare_1_1logger.html">aare::logger</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:namespaceaare_1_1logger_1_1internal"><td class="memItemLeft" align="right" valign="top">namespace &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceaare_1_1logger_1_1internal.html">aare::logger::internal</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="define-members" name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:ac27b81440ce6781d5bfcab7a9bbdef99"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="logger_8hpp.html#ac27b81440ce6781d5bfcab7a9bbdef99">LOCATION</a>&#160;&#160;&#160;std::string(__FILE__) + std::string(&quot;:&quot;) + std::to_string(__LINE__) + &quot;:&quot; + std::string(__func__) + &quot;:&quot;</td></tr>
<tr class="separator:ac27b81440ce6781d5bfcab7a9bbdef99"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="enum-members" name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:af49e00b36677b44ea78813c109b697ed"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceaare_1_1logger.html#af49e00b36677b44ea78813c109b697ed">aare::logger::LOGGING_LEVEL</a> { <a class="el" href="namespaceaare_1_1logger.html#af49e00b36677b44ea78813c109b697eda49a634116dfda67973725d859848ceda">aare::logger::DEBUG</a> = 0
, <a class="el" href="namespaceaare_1_1logger.html#af49e00b36677b44ea78813c109b697edaa299d78fc1de06730cc5c9e63992071f">aare::logger::INFO</a> = 1
, <a class="el" href="namespaceaare_1_1logger.html#af49e00b36677b44ea78813c109b697eda27d3614b3477d3fe03ac6eba997350c8">aare::logger::WARNING</a> = 2
, <a class="el" href="namespaceaare_1_1logger.html#af49e00b36677b44ea78813c109b697eda5e573dce2cdf7298dfcce0f91c9aef59">aare::logger::ERROR</a> = 3
}</td></tr>
<tr class="separator:af49e00b36677b44ea78813c109b697ed"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a9e4ea0ca899f97b1680d4193d7372c71"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr class="memitem:a9e4ea0ca899f97b1680d4193d7372c71"><td class="memTemplItemLeft" align="right" valign="top">std::ostream &amp;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="logger_8hpp.html#a9e4ea0ca899f97b1680d4193d7372c71">operator&lt;&lt;</a> (std::ostream &amp;out, const std::vector&lt; T &gt; &amp;v)</td></tr>
<tr class="separator:a9e4ea0ca899f97b1680d4193d7372c71"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2ed0d126d7ddc7335e7174abbc04b6a4"><td class="memTemplParams" colspan="2">template&lt;typename T , size_t N&gt; </td></tr>
<tr class="memitem:a2ed0d126d7ddc7335e7174abbc04b6a4"><td class="memTemplItemLeft" align="right" valign="top">std::ostream &amp;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="logger_8hpp.html#a2ed0d126d7ddc7335e7174abbc04b6a4">operator&lt;&lt;</a> (std::ostream &amp;out, const std::array&lt; T, N &gt; &amp;v)</td></tr>
<tr class="separator:a2ed0d126d7ddc7335e7174abbc04b6a4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7edea15fddf51d747c763deab919e17b"><td class="memTemplParams" colspan="2">template&lt;typename K , typename V &gt; </td></tr>
<tr class="memitem:a7edea15fddf51d747c763deab919e17b"><td class="memTemplItemLeft" align="right" valign="top">std::ostream &amp;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="logger_8hpp.html#a7edea15fddf51d747c763deab919e17b">operator&lt;&lt;</a> (std::ostream &amp;out, const std::map&lt; K, V &gt; &amp;v)</td></tr>
<tr class="separator:a7edea15fddf51d747c763deab919e17b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a937a16230b5f98a197ab370d3b807ec6"><td class="memTemplParams" colspan="2">template&lt;<a class="el" href="namespaceaare_1_1logger.html#af49e00b36677b44ea78813c109b697ed">LOGGING_LEVEL</a> level, typename... Strings&gt; </td></tr>
<tr class="memitem:a937a16230b5f98a197ab370d3b807ec6"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceaare_1_1logger.html#a937a16230b5f98a197ab370d3b807ec6">aare::logger::log</a> (const Strings... s)</td></tr>
<tr class="separator:a937a16230b5f98a197ab370d3b807ec6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abae5b0551a44b7a2820cf8136cc8b967"><td class="memTemplParams" colspan="2">template&lt;typename... Strings&gt; </td></tr>
<tr class="memitem:abae5b0551a44b7a2820cf8136cc8b967"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceaare_1_1logger.html#abae5b0551a44b7a2820cf8136cc8b967">aare::logger::debug</a> (const Strings... s)</td></tr>
<tr class="separator:abae5b0551a44b7a2820cf8136cc8b967"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad1d416cf2f59b9112627c6bc2b351218"><td class="memTemplParams" colspan="2">template&lt;typename... Strings&gt; </td></tr>
<tr class="memitem:ad1d416cf2f59b9112627c6bc2b351218"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceaare_1_1logger.html#ad1d416cf2f59b9112627c6bc2b351218">aare::logger::info</a> (const Strings... s)</td></tr>
<tr class="separator:ad1d416cf2f59b9112627c6bc2b351218"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1449109c5a71459c6c9a5e997d98127b"><td class="memTemplParams" colspan="2">template&lt;typename... Strings&gt; </td></tr>
<tr class="memitem:a1449109c5a71459c6c9a5e997d98127b"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceaare_1_1logger.html#a1449109c5a71459c6c9a5e997d98127b">aare::logger::warn</a> (const Strings... s)</td></tr>
<tr class="separator:a1449109c5a71459c6c9a5e997d98127b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa3c59889c871f655a4a576bad35cd0e7"><td class="memTemplParams" colspan="2">template&lt;typename... Strings&gt; </td></tr>
<tr class="memitem:aa3c59889c871f655a4a576bad35cd0e7"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceaare_1_1logger.html#aa3c59889c871f655a4a576bad35cd0e7">aare::logger::error</a> (const Strings... s)</td></tr>
<tr class="separator:aa3c59889c871f655a4a576bad35cd0e7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9615ab157fbc2bb3e9b2bfb65e12be8c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceaare_1_1logger.html#a9615ab157fbc2bb3e9b2bfb65e12be8c">aare::logger::set_streams</a> (std::streambuf *out, std::streambuf *err)</td></tr>
<tr class="separator:a9615ab157fbc2bb3e9b2bfb65e12be8c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab1dff5db561f3b7ebaee8428ab6d5b7d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceaare_1_1logger.html#ab1dff5db561f3b7ebaee8428ab6d5b7d">aare::logger::set_streams</a> (std::streambuf *out)</td></tr>
<tr class="separator:ab1dff5db561f3b7ebaee8428ab6d5b7d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a335576e89f0ac25831e1ff7abb3c67c8"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceaare_1_1logger.html#a335576e89f0ac25831e1ff7abb3c67c8">aare::logger::set_verbosity</a> (<a class="el" href="namespaceaare_1_1logger.html#af49e00b36677b44ea78813c109b697ed">LOGGING_LEVEL</a> level)</td></tr>
<tr class="separator:a335576e89f0ac25831e1ff7abb3c67c8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a42089a21b600c9733ff5a82138c4f53d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceaare_1_1logger.html#a42089a21b600c9733ff5a82138c4f53d">aare::logger::set_output_file</a> (std::string filename)</td></tr>
<tr class="separator:a42089a21b600c9733ff5a82138c4f53d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adfa4e46d0e102fd5f1eb9a6471eead60"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classaare_1_1logger_1_1Logger.html">Logger</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceaare_1_1logger.html#adfa4e46d0e102fd5f1eb9a6471eead60">aare::logger::get_logger_instance</a> ()</td></tr>
<tr class="separator:adfa4e46d0e102fd5f1eb9a6471eead60"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="var-members" name="var-members"></a>
Variables</h2></td></tr>
<tr class="memitem:a42d1e41bd805bdd6c87f2c36239d27bf"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classaare_1_1logger_1_1Logger.html">aare::logger::Logger</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceaare_1_1logger_1_1internal.html#a42d1e41bd805bdd6c87f2c36239d27bf">aare::logger::internal::logger_instance</a> = <a class="el" href="classaare_1_1logger_1_1Logger.html">aare::logger::Logger</a>()</td></tr>
<tr class="separator:a42d1e41bd805bdd6c87f2c36239d27bf"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a id="ac27b81440ce6781d5bfcab7a9bbdef99" name="ac27b81440ce6781d5bfcab7a9bbdef99"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac27b81440ce6781d5bfcab7a9bbdef99">&#9670;&#160;</a></span>LOCATION</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define LOCATION&#160;&#160;&#160;std::string(__FILE__) + std::string(&quot;:&quot;) + std::to_string(__LINE__) + &quot;:&quot; + std::string(__func__) + &quot;:&quot;</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="a2ed0d126d7ddc7335e7174abbc04b6a4" name="a2ed0d126d7ddc7335e7174abbc04b6a4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2ed0d126d7ddc7335e7174abbc04b6a4">&#9670;&#160;</a></span>operator&lt;&lt;() <span class="overload">[1/3]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T , size_t N&gt; </div>
<table class="memname">
<tr>
<td class="memname">std::ostream &amp; operator&lt;&lt; </td>
<td>(</td>
<td class="paramtype">std::ostream &amp;&#160;</td>
<td class="paramname"><em>out</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::array&lt; T, N &gt; &amp;&#160;</td>
<td class="paramname"><em>v</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a7edea15fddf51d747c763deab919e17b" name="a7edea15fddf51d747c763deab919e17b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7edea15fddf51d747c763deab919e17b">&#9670;&#160;</a></span>operator&lt;&lt;() <span class="overload">[2/3]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename K , typename V &gt; </div>
<table class="memname">
<tr>
<td class="memname">std::ostream &amp; operator&lt;&lt; </td>
<td>(</td>
<td class="paramtype">std::ostream &amp;&#160;</td>
<td class="paramname"><em>out</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::map&lt; K, V &gt; &amp;&#160;</td>
<td class="paramname"><em>v</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a9e4ea0ca899f97b1680d4193d7372c71" name="a9e4ea0ca899f97b1680d4193d7372c71"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9e4ea0ca899f97b1680d4193d7372c71">&#9670;&#160;</a></span>operator&lt;&lt;() <span class="overload">[3/3]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T &gt; </div>
<table class="memname">
<tr>
<td class="memname">std::ostream &amp; operator&lt;&lt; </td>
<td>(</td>
<td class="paramtype">std::ostream &amp;&#160;</td>
<td class="paramname"><em>out</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::vector&lt; T &gt; &amp;&#160;</td>
<td class="paramname"><em>v</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
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.9.7
</small></address>
</body>
</html>