detectors/aare
25
0
Fork 0
mirror of https://github.com/slsdetectorgroup/aare.git synced 2025-06-08 13:40:39 +02:00
Code Issues Actions Packages Releases Activity
aare/docs/html/ZmqHeader_8cpp.html
Bechir Braham 2ebbd0d7cd
setup doxygen and clang-uml files
2024-04-11 17:20:34 +02:00

272 lines
12 KiB
HTML
Raw Blame History

<!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: network_io/src/ZmqHeader.cpp 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_d6681e26bbdc40cc2b8fd2c1ffe8d5dc.html">network_io</a></li><li class="navelem"><a class="el" href="dir_7cbc3d10c42a4faef7d698f7ba5096c3.html">src</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#namespaces">Namespaces</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">ZmqHeader.cpp File Reference</div></div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &quot;<a class="el" href="ZmqHeader_8hpp_source.html">aare/network_io/ZmqHeader.hpp</a>&quot;</code><br />
<code>#include &quot;simdjson.h&quot;</code><br />
</div><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>
</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:a544ca552152d57c0006c6eb361b07aa7"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr class="memitem:a544ca552152d57c0006c6eb361b07aa7"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="ZmqHeader_8cpp.html#a544ca552152d57c0006c6eb361b07aa7">write_digit</a> (std::string &amp;s, const std::string &amp;key, const T &amp;value)</td></tr>
<tr class="memdesc:a544ca552152d57c0006c6eb361b07aa7"><td class="mdescLeft">&#160;</td><td class="mdescRight">write a digit to a string takes key and value and outputs-&gt;"key": value, <br /></td></tr>
<tr class="separator:a544ca552152d57c0006c6eb361b07aa7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3c314b7004ca6f606d7a24e861d4acd0"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="ZmqHeader_8cpp.html#a3c314b7004ca6f606d7a24e861d4acd0">write_str</a> (std::string &amp;s, const std::string &amp;key, const std::string &amp;value)</td></tr>
<tr class="separator:a3c314b7004ca6f606d7a24e861d4acd0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3fd7f2167e68c18f441b18e36c201362"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="ZmqHeader_8cpp.html#a3fd7f2167e68c18f441b18e36c201362">write_map</a> (std::string &amp;s, const std::string &amp;key, const std::map&lt; std::string, std::string &gt; &amp;value)</td></tr>
<tr class="separator:a3fd7f2167e68c18f441b18e36c201362"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a40da37505a8960ac3306e41d533e7aa4"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="ZmqHeader_8cpp.html#a40da37505a8960ac3306e41d533e7aa4">write_array</a> (std::string &amp;s, const std::string &amp;key, const std::array&lt; int, 4 &gt; &amp;value)</td></tr>
<tr class="separator:a40da37505a8960ac3306e41d533e7aa4"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a id="a40da37505a8960ac3306e41d533e7aa4" name="a40da37505a8960ac3306e41d533e7aa4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a40da37505a8960ac3306e41d533e7aa4">&#9670;&#160;</a></span>write_array()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void write_array </td>
<td>(</td>
<td class="paramtype">std::string &amp;&#160;</td>
<td class="paramname"><em>s</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::array&lt; int, 4 &gt; &amp;&#160;</td>
<td class="paramname"><em>value</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a544ca552152d57c0006c6eb361b07aa7" name="a544ca552152d57c0006c6eb361b07aa7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a544ca552152d57c0006c6eb361b07aa7">&#9670;&#160;</a></span>write_digit()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T &gt; </div>
<table class="memname">
<tr>
<td class="memname">void write_digit </td>
<td>(</td>
<td class="paramtype">std::string &amp;&#160;</td>
<td class="paramname"><em>s</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const T &amp;&#160;</td>
<td class="paramname"><em>value</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>write a digit to a string takes key and value and outputs-&gt;"key": value, </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">T</td><td>type of value (int, uint32_t, ...) </td></tr>
</table>
</dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">s</td><td>string to append to </td></tr>
<tr><td class="paramname">key</td><td>key to write </td></tr>
<tr><td class="paramname">value</td><td>value to write </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>void </dd></dl>
<dl class="section note"><dt>Note</dt><dd><ul>
<li>can't use concepts here because we are using c++17 </li>
</ul>
</dd></dl>
</div>
</div>
<a id="a3fd7f2167e68c18f441b18e36c201362" name="a3fd7f2167e68c18f441b18e36c201362"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3fd7f2167e68c18f441b18e36c201362">&#9670;&#160;</a></span>write_map()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void write_map </td>
<td>(</td>
<td class="paramtype">std::string &amp;&#160;</td>
<td class="paramname"><em>s</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::map&lt; std::string, std::string &gt; &amp;&#160;</td>
<td class="paramname"><em>value</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a3c314b7004ca6f606d7a24e861d4acd0" name="a3c314b7004ca6f606d7a24e861d4acd0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3c314b7004ca6f606d7a24e861d4acd0">&#9670;&#160;</a></span>write_str()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void write_str </td>
<td>(</td>
<td class="paramtype">std::string &amp;&#160;</td>
<td class="paramname"><em>s</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>value</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>
View Git Blame Copy Permalink