add Doxygen documentation
[o-du/phy.git] / docs / API / common_8cpp.html
diff --git a/docs/API/common_8cpp.html b/docs/API/common_8cpp.html
new file mode 100644 (file)
index 0000000..b68563e
--- /dev/null
@@ -0,0 +1,447 @@
+<!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"/>
+<meta http-equiv="X-UA-Compatible" content="IE=9"/>
+<meta name="generator" content="Doxygen 1.8.13"/>
+<meta name="viewport" content="width=device-width, initial-scale=1"/>
+<title>o-du/phy: common.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 style="height: 56px;">
+  <td id="projectalign" style="padding-left: 0.5em;">
+   <div id="projectname">o-du/phy
+   </div>
+   <div id="projectbrief">Intel O-RAN/X-RAN Generated Doxygen Documentation</div>
+  </td>
+ </tr>
+ </tbody>
+</table>
+</div>
+<!-- end header part -->
+<!-- Generated by Doxygen 1.8.13 -->
+<script type="text/javascript">
+var searchBox = new SearchBox("searchBox", "search",false,'Search');
+</script>
+<script type="text/javascript" src="menudata.js"></script>
+<script type="text/javascript" src="menu.js"></script>
+<script type="text/javascript">
+$(function() {
+  initMenu('',true,false,'search.php','Search');
+  $(document).ready(function() { init_search(); });
+});
+</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">
+<iframe src="javascript:void(0)" frameborder="0" 
+        name="MSearchResults" id="MSearchResults">
+</iframe>
+</div>
+
+<div id="nav-path" class="navpath">
+  <ul>
+<li class="navelem"><a class="el" href="dir_a4c74d6baed87eba72f3b201b7b4b8f2.html">fhi_lib</a></li><li class="navelem"><a class="el" href="dir_babe8eacf738372576863f88f66866a5.html">test</a></li><li class="navelem"><a class="el" href="dir_1bd9561fc3fad99ea06f3a94905f6e7f.html">common</a></li>  </ul>
+</div>
+</div><!-- top -->
+<div class="header">
+  <div class="summary">
+<a href="#define-members">Macros</a> &#124;
+<a href="#func-members">Functions</a>  </div>
+  <div class="headertitle">
+<div class="title">common.cpp File Reference</div>  </div>
+</div><!--header-->
+<div class="contents">
+<div class="textblock"><code>#include &lt;cmath&gt;</code><br />
+<code>#include &lt;fstream&gt;</code><br />
+<code>#include &lt;numeric&gt;</code><br />
+<code>#include &lt;unistd.h&gt;</code><br />
+<code>#include &lt;sys/syscall.h&gt;</code><br />
+<code>#include &quot;<a class="el" href="common_8hpp_source.html">common.hpp</a>&quot;</code><br />
+</div><div class="textblock"><div class="dynheader">
+Include dependency graph for common.cpp:</div>
+<div class="dyncontent">
+<div class="center"><img src="common_8cpp__incl.png" border="0" usemap="#common_8cpp" alt=""/></div>
+<map name="common_8cpp" id="common_8cpp">
+<area shape="rect" id="node7" href="common_8hpp.html" title="common.hpp" alt="" coords="1442,80,1539,107"/>
+<area shape="rect" id="node18" href="common__typedef__xran_8h.html" title="This header file defines those data type both used by eNB and UE. " alt="" coords="2441,155,2607,181"/>
+<area shape="rect" id="node22" href="json_8hpp.html" title="json.hpp" alt="" coords="1165,155,1235,181"/>
+</map>
+</div>
+</div>
+<p><a href="common_8cpp_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 name="define-members"></a>
+Macros</h2></td></tr>
+<tr class="memitem:a80c653d62783a4e7ea960794bd287b49"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="common_8cpp.html#a80c653d62783a4e7ea960794bd287b49">CPU_ID</a>&#160;&#160;&#160;4</td></tr>
+<tr class="separator:a80c653d62783a4e7ea960794bd287b49"><td class="memSeparator" colspan="2">&#160;</td></tr>
+</table><table class="memberdecls">
+<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
+Functions</h2></td></tr>
+<tr class="memitem:ae39390f41ba978a1f0d79691436c074a"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="common_8cpp.html#ae39390f41ba978a1f0d79691436c074a">bind_to_cpu</a> (const unsigned cpu)</td></tr>
+<tr class="memdesc:ae39390f41ba978a1f0d79691436c074a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Attach current process to the selected core.  <a href="#ae39390f41ba978a1f0d79691436c074a">More...</a><br /></td></tr>
+<tr class="separator:ae39390f41ba978a1f0d79691436c074a"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a8265b710246f9019ff14556adf5eb35a"><td class="memItemLeft" align="right" valign="top">std::pair&lt; double, double &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="common_8cpp.html#a8265b710246f9019ff14556adf5eb35a">calculate_statistics</a> (const std::vector&lt; long &gt; values)</td></tr>
+<tr class="memdesc:a8265b710246f9019ff14556adf5eb35a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Calculate the mean and variance from the result of the run_benchmark.  <a href="#a8265b710246f9019ff14556adf5eb35a">More...</a><br /></td></tr>
+<tr class="separator:a8265b710246f9019ff14556adf5eb35a"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a39bf4f7770751080f5b72046abfd01a5"><td class="memItemLeft" align="right" valign="top">std::vector&lt; unsigned &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="common_8cpp.html#a39bf4f7770751080f5b72046abfd01a5">get_sequence</a> (const unsigned number)</td></tr>
+<tr class="memdesc:a39bf4f7770751080f5b72046abfd01a5"><td class="mdescLeft">&#160;</td><td class="mdescRight">For a given number return sequence of number from 0 to number - 1.  <a href="#a39bf4f7770751080f5b72046abfd01a5">More...</a><br /></td></tr>
+<tr class="separator:a39bf4f7770751080f5b72046abfd01a5"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a876ed07783b27d38779f7cef4db673e6"><td class="memItemLeft" align="right" valign="top">char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="common_8cpp.html#a876ed07783b27d38779f7cef4db673e6">read_data_to_aligned_array</a> (const std::string &amp;filename)</td></tr>
+<tr class="memdesc:a876ed07783b27d38779f7cef4db673e6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Read binary data from the file.  <a href="#a876ed07783b27d38779f7cef4db673e6">More...</a><br /></td></tr>
+<tr class="separator:a876ed07783b27d38779f7cef4db673e6"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ad8c062e9b24e4b3a8408b23a0d8ab428"><td class="memItemLeft" align="right" valign="top"><a class="el" href="common_8hpp.html#ab701e3ac61a85b337ec5c1abaad6742d">json</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="common_8cpp.html#ad8c062e9b24e4b3a8408b23a0d8ab428">read_json_from_file</a> (const std::string &amp;filename)</td></tr>
+<tr class="memdesc:ad8c062e9b24e4b3a8408b23a0d8ab428"><td class="mdescLeft">&#160;</td><td class="mdescRight">Read JSON from the given file.  <a href="#ad8c062e9b24e4b3a8408b23a0d8ab428">More...</a><br /></td></tr>
+<tr class="separator:ad8c062e9b24e4b3a8408b23a0d8ab428"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a56c41cbb9de4bce25da45ecd74b46a81"><td class="memItemLeft" align="right" valign="top">unsigned long&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="common_8cpp.html#a56c41cbb9de4bce25da45ecd74b46a81">tsc_recovery</a> ()</td></tr>
+<tr class="memdesc:a56c41cbb9de4bce25da45ecd74b46a81"><td class="mdescLeft">&#160;</td><td class="mdescRight">Measure the TSC on the machine.  <a href="#a56c41cbb9de4bce25da45ecd74b46a81">More...</a><br /></td></tr>
+<tr class="separator:a56c41cbb9de4bce25da45ecd74b46a81"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a0ab5719a5f67d4d52057b2c4550fe930"><td class="memItemLeft" align="right" valign="top">unsigned long&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="common_8cpp.html#a0ab5719a5f67d4d52057b2c4550fe930">tsc_tick</a> ()</td></tr>
+<tr class="memdesc:a0ab5719a5f67d4d52057b2c4550fe930"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the current value of the TSC.  <a href="#a0ab5719a5f67d4d52057b2c4550fe930">More...</a><br /></td></tr>
+<tr class="separator:a0ab5719a5f67d4d52057b2c4550fe930"><td class="memSeparator" colspan="2">&#160;</td></tr>
+</table>
+<h2 class="groupheader">Macro Definition Documentation</h2>
+<a id="a80c653d62783a4e7ea960794bd287b49"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a80c653d62783a4e7ea960794bd287b49">&#9670;&nbsp;</a></span>CPU_ID</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">#define CPU_ID&#160;&#160;&#160;4</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p class="definition">Definition at line <a class="el" href="common_8cpp_source.html#l00034">34</a> of file <a class="el" href="common_8cpp_source.html">common.cpp</a>.</p>
+
+</div>
+</div>
+<h2 class="groupheader">Function Documentation</h2>
+<a id="ae39390f41ba978a1f0d79691436c074a"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#ae39390f41ba978a1f0d79691436c074a">&#9670;&nbsp;</a></span>bind_to_cpu()</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">int bind_to_cpu </td>
+          <td>(</td>
+          <td class="paramtype">const unsigned&#160;</td>
+          <td class="paramname"><em>cpu</em></td><td>)</td>
+          <td></td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p>Attach current process to the selected core. </p>
+<dl class="params"><dt>Parameters</dt><dd>
+  <table class="params">
+    <tr><td class="paramdir">[in]</td><td class="paramname">cpu</td><td>Core number. </td></tr>
+  </table>
+  </dd>
+</dl>
+<dl class="section return"><dt>Returns</dt><dd>0 on success, -1 otherwise. </dd></dl>
+
+<p class="definition">Definition at line <a class="el" href="common_8cpp_source.html#l00047">47</a> of file <a class="el" href="common_8cpp_source.html">common.cpp</a>.</p>
+<div class="dynheader">
+Here is the caller graph for this function:</div>
+<div class="dyncontent">
+<div class="center"><img src="common_8cpp_ae39390f41ba978a1f0d79691436c074a_icgraph.png" border="0" usemap="#common_8cpp_ae39390f41ba978a1f0d79691436c074a_icgraph" alt=""/></div>
+<map name="common_8cpp_ae39390f41ba978a1f0d79691436c074a_icgraph" id="common_8cpp_ae39390f41ba978a1f0d79691436c074a_icgraph">
+<area shape="rect" id="node2" href="structreading__input__file__exception.html#a70518905d36686ddeeb2eb3b2682f016" title="reading_input_file\l_exception::what" alt="" coords="170,71,293,112"/>
+<area shape="rect" id="node5" href="class_kernel_tests.html#a3cf2e25a99be565a4ab570737cfeac41" title="Run performance test case for a given function. " alt="" coords="145,137,317,163"/>
+<area shape="rect" id="node3" href="class_kernel_tests.html#a6dc1bccfd02f1a94b5c799c15cd98135" title="Load selected data from a JSON object. get_input_parameter loads data from parameters section of the ..." alt="" coords="378,5,531,47"/>
+<area shape="rect" id="node4" href="class_kernel_tests.html#adfbe724335d86320c9839c426c4d5715" title="KernelTests::get_reference\l_parameter" alt="" coords="365,71,544,112"/>
+<area shape="rect" id="node6" href="c__plane__tests_8cc.html#a21d05f2c6607fc534e67ed32883de81f" title="TEST_P" alt="" coords="419,137,491,163"/>
+</map>
+</div>
+
+</div>
+</div>
+<a id="a8265b710246f9019ff14556adf5eb35a"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a8265b710246f9019ff14556adf5eb35a">&#9670;&nbsp;</a></span>calculate_statistics()</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">std::pair&lt;double, double&gt; calculate_statistics </td>
+          <td>(</td>
+          <td class="paramtype">const std::vector&lt; long &gt;&#160;</td>
+          <td class="paramname"><em>values</em></td><td>)</td>
+          <td></td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p>Calculate the mean and variance from the result of the run_benchmark. </p>
+<dl class="params"><dt>Parameters</dt><dd>
+  <table class="params">
+    <tr><td class="paramdir">[in]</td><td class="paramname">values</td><td>Vector with result values. </td></tr>
+  </table>
+  </dd>
+</dl>
+<dl class="section return"><dt>Returns</dt><dd>std::pair where the first element is mean and the second one is standard deviation. </dd></dl>
+<dl class="section note"><dt>Note</dt><dd>It's not a general mean/stddev function it only works properly when feed with data from the benchmark function. </dd></dl>
+
+<p class="definition">Definition at line <a class="el" href="common_8cpp_source.html#l00060">60</a> of file <a class="el" href="common_8cpp_source.html">common.cpp</a>.</p>
+<div class="dynheader">
+Here is the caller graph for this function:</div>
+<div class="dyncontent">
+<div class="center"><img src="common_8cpp_a8265b710246f9019ff14556adf5eb35a_icgraph.png" border="0" usemap="#common_8cpp_a8265b710246f9019ff14556adf5eb35a_icgraph" alt=""/></div>
+<map name="common_8cpp_a8265b710246f9019ff14556adf5eb35a_icgraph" id="common_8cpp_a8265b710246f9019ff14556adf5eb35a_icgraph">
+<area shape="rect" id="node2" href="structreading__input__file__exception.html#a70518905d36686ddeeb2eb3b2682f016" title="reading_input_file\l_exception::what" alt="" coords="188,71,311,112"/>
+<area shape="rect" id="node5" href="common_8hpp.html#af69d779517f2bdee3aba95bc38022074" title="Run the given function and return the mean run time and stddev. " alt="" coords="194,137,305,163"/>
+<area shape="rect" id="node3" href="class_kernel_tests.html#a6dc1bccfd02f1a94b5c799c15cd98135" title="Load selected data from a JSON object. get_input_parameter loads data from parameters section of the ..." alt="" coords="371,5,525,47"/>
+<area shape="rect" id="node4" href="class_kernel_tests.html#adfbe724335d86320c9839c426c4d5715" title="KernelTests::get_reference\l_parameter" alt="" coords="359,71,537,112"/>
+<area shape="rect" id="node6" href="class_kernel_tests.html#a3cf2e25a99be565a4ab570737cfeac41" title="Run performance test case for a given function. " alt="" coords="362,137,534,163"/>
+<area shape="rect" id="node7" href="c__plane__tests_8cc.html#a21d05f2c6607fc534e67ed32883de81f" title="TEST_P" alt="" coords="585,137,657,163"/>
+</map>
+</div>
+
+</div>
+</div>
+<a id="a39bf4f7770751080f5b72046abfd01a5"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a39bf4f7770751080f5b72046abfd01a5">&#9670;&nbsp;</a></span>get_sequence()</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">std::vector&lt;unsigned&gt; get_sequence </td>
+          <td>(</td>
+          <td class="paramtype">const unsigned&#160;</td>
+          <td class="paramname"><em>number</em></td><td>)</td>
+          <td></td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p>For a given number return sequence of number from 0 to number - 1. </p>
+<dl class="params"><dt>Parameters</dt><dd>
+  <table class="params">
+    <tr><td class="paramdir">[in]</td><td class="paramname">number</td><td>Positive integer value. </td></tr>
+  </table>
+  </dd>
+</dl>
+<dl class="section return"><dt>Returns</dt><dd>Vector with the sorted integer numbers between 0 and number - 1. </dd></dl>
+
+<p class="definition">Definition at line <a class="el" href="common_8cpp_source.html#l00078">78</a> of file <a class="el" href="common_8cpp_source.html">common.cpp</a>.</p>
+<div class="dynheader">
+Here is the caller graph for this function:</div>
+<div class="dyncontent">
+<div class="center"><img src="common_8cpp_a39bf4f7770751080f5b72046abfd01a5_icgraph.png" border="0" usemap="#common_8cpp_a39bf4f7770751080f5b72046abfd01a5_icgraph" alt=""/></div>
+<map name="common_8cpp_a39bf4f7770751080f5b72046abfd01a5_icgraph" id="common_8cpp_a39bf4f7770751080f5b72046abfd01a5_icgraph">
+<area shape="rect" id="node2" href="c__plane__tests_8cc.html#ab0ad0e23f1b51f15bd9594a24a2c438f" title="TEST_P" alt="" coords="181,5,253,32"/>
+<area shape="rect" id="node3" href="structreading__input__file__exception.html#a70518905d36686ddeeb2eb3b2682f016" title="reading_input_file\l_exception::what" alt="" coords="156,57,279,98"/>
+<area shape="rect" id="node4" href="class_kernel_tests.html#a6dc1bccfd02f1a94b5c799c15cd98135" title="Load selected data from a JSON object. get_input_parameter loads data from parameters section of the ..." alt="" coords="339,23,493,65"/>
+<area shape="rect" id="node5" href="class_kernel_tests.html#adfbe724335d86320c9839c426c4d5715" title="KernelTests::get_reference\l_parameter" alt="" coords="327,89,505,130"/>
+</map>
+</div>
+
+</div>
+</div>
+<a id="a876ed07783b27d38779f7cef4db673e6"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a876ed07783b27d38779f7cef4db673e6">&#9670;&nbsp;</a></span>read_data_to_aligned_array()</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">char* read_data_to_aligned_array </td>
+          <td>(</td>
+          <td class="paramtype">const std::string &amp;&#160;</td>
+          <td class="paramname"><em>filename</em></td><td>)</td>
+          <td></td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p>Read binary data from the file. </p>
+<dl class="params"><dt>Parameters</dt><dd>
+  <table class="params">
+    <tr><td class="paramdir">[in]</td><td class="paramname">filename</td><td>name of the binary file. </td></tr>
+  </table>
+  </dd>
+</dl>
+<dl class="section return"><dt>Returns</dt><dd>Pointer to the allocated memory with data from the file. </dd></dl>
+<dl class="exception"><dt>Exceptions</dt><dd>
+  <table class="exception">
+    <tr><td class="paramname">std::runtime_error</td><td>when memory cannot be allocated. </td></tr>
+  </table>
+  </dd>
+</dl>
+
+<p class="definition">Definition at line <a class="el" href="common_8cpp_source.html#l00086">86</a> of file <a class="el" href="common_8cpp_source.html">common.cpp</a>.</p>
+<div class="dynheader">
+Here is the caller graph for this function:</div>
+<div class="dyncontent">
+<div class="center"><img src="common_8cpp_a876ed07783b27d38779f7cef4db673e6_icgraph.png" border="0" usemap="#common_8cpp_a876ed07783b27d38779f7cef4db673e6_icgraph" alt=""/></div>
+<map name="common_8cpp_a876ed07783b27d38779f7cef4db673e6_icgraph" id="common_8cpp_a876ed07783b27d38779f7cef4db673e6_icgraph">
+<area shape="rect" id="node2" href="structreading__input__file__exception.html#a70518905d36686ddeeb2eb3b2682f016" title="reading_input_file\l_exception::what" alt="" coords="211,71,333,112"/>
+<area shape="rect" id="node5" href="class_kernel_tests.html#abf28e5ea54fab2b0685972fe6e75560a" title="Defines section in the conf.json that is used to load parameters from. " alt="" coords="199,238,345,265"/>
+<area shape="rect" id="node3" href="class_kernel_tests.html#a6dc1bccfd02f1a94b5c799c15cd98135" title="Load selected data from a JSON object. get_input_parameter loads data from parameters section of the ..." alt="" coords="406,5,559,47"/>
+<area shape="rect" id="node4" href="class_kernel_tests.html#adfbe724335d86320c9839c426c4d5715" title="KernelTests::get_reference\l_parameter" alt="" coords="393,71,572,112"/>
+<area shape="rect" id="node6" href="class_c__plane.html#a3a1707f6479611fdc609a3eb8a0cef1b" title="C_plane::SetUp" alt="" coords="425,137,540,163"/>
+<area shape="rect" id="node7" href="class_test_chain.html#a3a1707f6479611fdc609a3eb8a0cef1b" title="TestChain::SetUp" alt="" coords="419,187,546,214"/>
+<area shape="rect" id="node8" href="class_prach_check.html#a3a1707f6479611fdc609a3eb8a0cef1b" title="PrachCheck::SetUp" alt="" coords="413,238,552,265"/>
+<area shape="rect" id="node9" href="class_prach_perf.html#a3a1707f6479611fdc609a3eb8a0cef1b" title="PrachPerf::SetUp" alt="" coords="420,289,545,315"/>
+<area shape="rect" id="node10" href="class_u__plane_check.html#a3a1707f6479611fdc609a3eb8a0cef1b" title="U_planeCheck::SetUp" alt="" coords="406,339,559,366"/>
+<area shape="rect" id="node11" href="class_u__plane_perf.html#a3a1707f6479611fdc609a3eb8a0cef1b" title="U_planePerf::SetUp" alt="" coords="413,390,552,417"/>
+</map>
+</div>
+
+</div>
+</div>
+<a id="ad8c062e9b24e4b3a8408b23a0d8ab428"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#ad8c062e9b24e4b3a8408b23a0d8ab428">&#9670;&nbsp;</a></span>read_json_from_file()</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname"><a class="el" href="common_8hpp.html#ab701e3ac61a85b337ec5c1abaad6742d">json</a> read_json_from_file </td>
+          <td>(</td>
+          <td class="paramtype">const std::string &amp;&#160;</td>
+          <td class="paramname"><em>filename</em></td><td>)</td>
+          <td></td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p>Read JSON from the given file. </p>
+<dl class="params"><dt>Parameters</dt><dd>
+  <table class="params">
+    <tr><td class="paramdir">[in]</td><td class="paramname">filename</td><td>name of the .json file. </td></tr>
+  </table>
+  </dd>
+</dl>
+<dl class="section return"><dt>Returns</dt><dd>JSON object with data. </dd></dl>
+<dl class="exception"><dt>Exceptions</dt><dd>
+  <table class="exception">
+    <tr><td class="paramname"><a class="el" href="structmissing__config__file__exception.html">missing_config_file_exception</a></td><td>when file cannot be opened. </td></tr>
+  </table>
+  </dd>
+</dl>
+
+<p class="definition">Definition at line <a class="el" href="common_8cpp_source.html#l00106">106</a> of file <a class="el" href="common_8cpp_source.html">common.cpp</a>.</p>
+<div class="dynheader">
+Here is the caller graph for this function:</div>
+<div class="dyncontent">
+<div class="center"><img src="common_8cpp_ad8c062e9b24e4b3a8408b23a0d8ab428_icgraph.png" border="0" usemap="#common_8cpp_ad8c062e9b24e4b3a8408b23a0d8ab428_icgraph" alt=""/></div>
+<map name="common_8cpp_ad8c062e9b24e4b3a8408b23a0d8ab428_icgraph" id="common_8cpp_ad8c062e9b24e4b3a8408b23a0d8ab428_icgraph">
+<area shape="rect" id="node2" href="structreading__input__file__exception.html#a70518905d36686ddeeb2eb3b2682f016" title="reading_input_file\l_exception::what" alt="" coords="226,41,349,83"/>
+<area shape="rect" id="node5" href="class_kernel_tests.html#aad8181b222f27240e9f07dcb6e620fa3" title="KernelTests::SetUpTestCase" alt="" coords="190,107,385,134"/>
+<area shape="rect" id="node6" href="class_kernel_tests.html#a6157ff083be863bba0a7804cd1788d96" title="KernelTests::get_number\l_of_cases" alt="" coords="203,159,371,200"/>
+<area shape="rect" id="node8" href="classxran_lib_wraper.html#a2e64fc338fcfaac25af91aae564777fa" title="xranLibWraper::xranLibWraper" alt="" coords="188,225,387,251"/>
+<area shape="rect" id="node3" href="class_kernel_tests.html#a6dc1bccfd02f1a94b5c799c15cd98135" title="Load selected data from a JSON object. get_input_parameter loads data from parameters section of the ..." alt="" coords="447,5,601,47"/>
+<area shape="rect" id="node4" href="class_kernel_tests.html#adfbe724335d86320c9839c426c4d5715" title="KernelTests::get_reference\l_parameter" alt="" coords="435,71,613,112"/>
+<area shape="rect" id="node7" href="c__plane__tests_8cc.html#ab0ad0e23f1b51f15bd9594a24a2c438f" title="TEST_P" alt="" coords="488,166,560,193"/>
+</map>
+</div>
+
+</div>
+</div>
+<a id="a56c41cbb9de4bce25da45ecd74b46a81"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a56c41cbb9de4bce25da45ecd74b46a81">&#9670;&nbsp;</a></span>tsc_recovery()</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">unsigned long tsc_recovery </td>
+          <td>(</td>
+          <td class="paramname"></td><td>)</td>
+          <td></td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p>Measure the TSC on the machine. </p>
+<dl class="section return"><dt>Returns</dt><dd>Number of ticks per us </dd></dl>
+
+<p class="definition">Definition at line <a class="el" href="common_8cpp_source.html#l00119">119</a> of file <a class="el" href="common_8cpp_source.html">common.cpp</a>.</p>
+<div class="dynheader">
+Here is the call graph for this function:</div>
+<div class="dyncontent">
+<div class="center"><img src="common_8cpp_a56c41cbb9de4bce25da45ecd74b46a81_cgraph.png" border="0" usemap="#common_8cpp_a56c41cbb9de4bce25da45ecd74b46a81_cgraph" alt=""/></div>
+<map name="common_8cpp_a56c41cbb9de4bce25da45ecd74b46a81_cgraph" id="common_8cpp_a56c41cbb9de4bce25da45ecd74b46a81_cgraph">
+<area shape="rect" id="node2" href="common_8cpp.html#a0ab5719a5f67d4d52057b2c4550fe930" title="Return the current value of the TSC. " alt="" coords="151,5,219,32"/>
+</map>
+</div>
+<div class="dynheader">
+Here is the caller graph for this function:</div>
+<div class="dyncontent">
+<div class="center"><img src="common_8cpp_a56c41cbb9de4bce25da45ecd74b46a81_icgraph.png" border="0" usemap="#common_8cpp_a56c41cbb9de4bce25da45ecd74b46a81_icgraph" alt=""/></div>
+<map name="common_8cpp_a56c41cbb9de4bce25da45ecd74b46a81_icgraph" id="common_8cpp_a56c41cbb9de4bce25da45ecd74b46a81_icgraph">
+<area shape="rect" id="node2" href="structreading__input__file__exception.html#a70518905d36686ddeeb2eb3b2682f016" title="reading_input_file\l_exception::what" alt="" coords="187,39,309,80"/>
+<area shape="rect" id="node5" href="class_kernel_tests.html#aad8181b222f27240e9f07dcb6e620fa3" title="KernelTests::SetUpTestCase" alt="" coords="151,105,345,131"/>
+<area shape="rect" id="node3" href="class_kernel_tests.html#a6dc1bccfd02f1a94b5c799c15cd98135" title="Load selected data from a JSON object. get_input_parameter loads data from parameters section of the ..." alt="" coords="406,5,559,47"/>
+<area shape="rect" id="node4" href="class_kernel_tests.html#adfbe724335d86320c9839c426c4d5715" title="KernelTests::get_reference\l_parameter" alt="" coords="393,71,572,112"/>
+</map>
+</div>
+
+</div>
+</div>
+<a id="a0ab5719a5f67d4d52057b2c4550fe930"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a0ab5719a5f67d4d52057b2c4550fe930">&#9670;&nbsp;</a></span>tsc_tick()</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">unsigned long tsc_tick </td>
+          <td>(</td>
+          <td class="paramname"></td><td>)</td>
+          <td></td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p>Return the current value of the TSC. </p>
+<dl class="section return"><dt>Returns</dt><dd>Current TSC value </dd></dl>
+
+<p class="definition">Definition at line <a class="el" href="common_8cpp_source.html#l00162">162</a> of file <a class="el" href="common_8cpp_source.html">common.cpp</a>.</p>
+<div class="dynheader">
+Here is the caller graph for this function:</div>
+<div class="dyncontent">
+<div class="center"><img src="common_8cpp_a0ab5719a5f67d4d52057b2c4550fe930_icgraph.png" border="0" usemap="#common_8cpp_a0ab5719a5f67d4d52057b2c4550fe930_icgraph" alt=""/></div>
+<map name="common_8cpp_a0ab5719a5f67d4d52057b2c4550fe930_icgraph" id="common_8cpp_a0ab5719a5f67d4d52057b2c4550fe930_icgraph">
+<area shape="rect" id="node2" href="common_8hpp.html#a56c41cbb9de4bce25da45ecd74b46a81" title="Measure the TSC on the machine. " alt="" coords="121,95,219,122"/>
+<area shape="rect" id="node3" href="structreading__input__file__exception.html#a70518905d36686ddeeb2eb3b2682f016" title="reading_input_file\l_exception::what" alt="" coords="303,37,425,79"/>
+<area shape="rect" id="node6" href="class_kernel_tests.html#aad8181b222f27240e9f07dcb6e620fa3" title="KernelTests::SetUpTestCase" alt="" coords="267,103,461,130"/>
+<area shape="rect" id="node4" href="class_kernel_tests.html#a6dc1bccfd02f1a94b5c799c15cd98135" title="Load selected data from a JSON object. get_input_parameter loads data from parameters section of the ..." alt="" coords="522,5,675,47"/>
+<area shape="rect" id="node5" href="class_kernel_tests.html#adfbe724335d86320c9839c426c4d5715" title="KernelTests::get_reference\l_parameter" alt="" coords="509,71,688,112"/>
+</map>
+</div>
+
+</div>
+</div>
+</div><!-- contents -->
+<!-- start footer part -->
+<hr class="footer"/><address class="footer"><small>
+Generated by &#160;<a href="http://www.doxygen.org/index.html">
+<img class="footer" src="doxygen.png" alt="doxygen"/>
+</a> 1.8.13
+</small></address>
+</body>
+</html>