add Doxygen documentation
[o-du/phy.git] / docs / API / common_8cpp.html
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2 <html xmlns="http://www.w3.org/1999/xhtml">
3 <head>
4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
6 <meta name="generator" content="Doxygen 1.8.13"/>
7 <meta name="viewport" content="width=device-width, initial-scale=1"/>
8 <title>o-du/phy: common.cpp File Reference</title>
9 <link href="tabs.css" rel="stylesheet" type="text/css"/>
10 <script type="text/javascript" src="jquery.js"></script>
11 <script type="text/javascript" src="dynsections.js"></script>
12 <link href="search/search.css" rel="stylesheet" type="text/css"/>
13 <script type="text/javascript" src="search/searchdata.js"></script>
14 <script type="text/javascript" src="search/search.js"></script>
15 <link href="doxygen.css" rel="stylesheet" type="text/css" />
16 </head>
17 <body>
18 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
19 <div id="titlearea">
20 <table cellspacing="0" cellpadding="0">
21  <tbody>
22  <tr style="height: 56px;">
23   <td id="projectalign" style="padding-left: 0.5em;">
24    <div id="projectname">o-du/phy
25    </div>
26    <div id="projectbrief">Intel O-RAN/X-RAN Generated Doxygen Documentation</div>
27   </td>
28  </tr>
29  </tbody>
30 </table>
31 </div>
32 <!-- end header part -->
33 <!-- Generated by Doxygen 1.8.13 -->
34 <script type="text/javascript">
35 var searchBox = new SearchBox("searchBox", "search",false,'Search');
36 </script>
37 <script type="text/javascript" src="menudata.js"></script>
38 <script type="text/javascript" src="menu.js"></script>
39 <script type="text/javascript">
40 $(function() {
41   initMenu('',true,false,'search.php','Search');
42   $(document).ready(function() { init_search(); });
43 });
44 </script>
45 <div id="main-nav"></div>
46 <!-- window showing the filter options -->
47 <div id="MSearchSelectWindow"
48      onmouseover="return searchBox.OnSearchSelectShow()"
49      onmouseout="return searchBox.OnSearchSelectHide()"
50      onkeydown="return searchBox.OnSearchSelectKey(event)">
51 </div>
52
53 <!-- iframe showing the search results (closed by default) -->
54 <div id="MSearchResultsWindow">
55 <iframe src="javascript:void(0)" frameborder="0" 
56         name="MSearchResults" id="MSearchResults">
57 </iframe>
58 </div>
59
60 <div id="nav-path" class="navpath">
61   <ul>
62 <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>
63 </div>
64 </div><!-- top -->
65 <div class="header">
66   <div class="summary">
67 <a href="#define-members">Macros</a> &#124;
68 <a href="#func-members">Functions</a>  </div>
69   <div class="headertitle">
70 <div class="title">common.cpp File Reference</div>  </div>
71 </div><!--header-->
72 <div class="contents">
73 <div class="textblock"><code>#include &lt;cmath&gt;</code><br />
74 <code>#include &lt;fstream&gt;</code><br />
75 <code>#include &lt;numeric&gt;</code><br />
76 <code>#include &lt;unistd.h&gt;</code><br />
77 <code>#include &lt;sys/syscall.h&gt;</code><br />
78 <code>#include &quot;<a class="el" href="common_8hpp_source.html">common.hpp</a>&quot;</code><br />
79 </div><div class="textblock"><div class="dynheader">
80 Include dependency graph for common.cpp:</div>
81 <div class="dyncontent">
82 <div class="center"><img src="common_8cpp__incl.png" border="0" usemap="#common_8cpp" alt=""/></div>
83 <map name="common_8cpp" id="common_8cpp">
84 <area shape="rect" id="node7" href="common_8hpp.html" title="common.hpp" alt="" coords="1442,80,1539,107"/>
85 <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"/>
86 <area shape="rect" id="node22" href="json_8hpp.html" title="json.hpp" alt="" coords="1165,155,1235,181"/>
87 </map>
88 </div>
89 </div>
90 <p><a href="common_8cpp_source.html">Go to the source code of this file.</a></p>
91 <table class="memberdecls">
92 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
93 Macros</h2></td></tr>
94 <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>
95 <tr class="separator:a80c653d62783a4e7ea960794bd287b49"><td class="memSeparator" colspan="2">&#160;</td></tr>
96 </table><table class="memberdecls">
97 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
98 Functions</h2></td></tr>
99 <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>
100 <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>
101 <tr class="separator:ae39390f41ba978a1f0d79691436c074a"><td class="memSeparator" colspan="2">&#160;</td></tr>
102 <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>
103 <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>
104 <tr class="separator:a8265b710246f9019ff14556adf5eb35a"><td class="memSeparator" colspan="2">&#160;</td></tr>
105 <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>
106 <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>
107 <tr class="separator:a39bf4f7770751080f5b72046abfd01a5"><td class="memSeparator" colspan="2">&#160;</td></tr>
108 <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>
109 <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>
110 <tr class="separator:a876ed07783b27d38779f7cef4db673e6"><td class="memSeparator" colspan="2">&#160;</td></tr>
111 <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>
112 <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>
113 <tr class="separator:ad8c062e9b24e4b3a8408b23a0d8ab428"><td class="memSeparator" colspan="2">&#160;</td></tr>
114 <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>
115 <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>
116 <tr class="separator:a56c41cbb9de4bce25da45ecd74b46a81"><td class="memSeparator" colspan="2">&#160;</td></tr>
117 <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>
118 <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>
119 <tr class="separator:a0ab5719a5f67d4d52057b2c4550fe930"><td class="memSeparator" colspan="2">&#160;</td></tr>
120 </table>
121 <h2 class="groupheader">Macro Definition Documentation</h2>
122 <a id="a80c653d62783a4e7ea960794bd287b49"></a>
123 <h2 class="memtitle"><span class="permalink"><a href="#a80c653d62783a4e7ea960794bd287b49">&#9670;&nbsp;</a></span>CPU_ID</h2>
124
125 <div class="memitem">
126 <div class="memproto">
127       <table class="memname">
128         <tr>
129           <td class="memname">#define CPU_ID&#160;&#160;&#160;4</td>
130         </tr>
131       </table>
132 </div><div class="memdoc">
133
134 <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>
135
136 </div>
137 </div>
138 <h2 class="groupheader">Function Documentation</h2>
139 <a id="ae39390f41ba978a1f0d79691436c074a"></a>
140 <h2 class="memtitle"><span class="permalink"><a href="#ae39390f41ba978a1f0d79691436c074a">&#9670;&nbsp;</a></span>bind_to_cpu()</h2>
141
142 <div class="memitem">
143 <div class="memproto">
144       <table class="memname">
145         <tr>
146           <td class="memname">int bind_to_cpu </td>
147           <td>(</td>
148           <td class="paramtype">const unsigned&#160;</td>
149           <td class="paramname"><em>cpu</em></td><td>)</td>
150           <td></td>
151         </tr>
152       </table>
153 </div><div class="memdoc">
154
155 <p>Attach current process to the selected core. </p>
156 <dl class="params"><dt>Parameters</dt><dd>
157   <table class="params">
158     <tr><td class="paramdir">[in]</td><td class="paramname">cpu</td><td>Core number. </td></tr>
159   </table>
160   </dd>
161 </dl>
162 <dl class="section return"><dt>Returns</dt><dd>0 on success, -1 otherwise. </dd></dl>
163
164 <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>
165 <div class="dynheader">
166 Here is the caller graph for this function:</div>
167 <div class="dyncontent">
168 <div class="center"><img src="common_8cpp_ae39390f41ba978a1f0d79691436c074a_icgraph.png" border="0" usemap="#common_8cpp_ae39390f41ba978a1f0d79691436c074a_icgraph" alt=""/></div>
169 <map name="common_8cpp_ae39390f41ba978a1f0d79691436c074a_icgraph" id="common_8cpp_ae39390f41ba978a1f0d79691436c074a_icgraph">
170 <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"/>
171 <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"/>
172 <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"/>
173 <area shape="rect" id="node4" href="class_kernel_tests.html#adfbe724335d86320c9839c426c4d5715" title="KernelTests::get_reference\l_parameter" alt="" coords="365,71,544,112"/>
174 <area shape="rect" id="node6" href="c__plane__tests_8cc.html#a21d05f2c6607fc534e67ed32883de81f" title="TEST_P" alt="" coords="419,137,491,163"/>
175 </map>
176 </div>
177
178 </div>
179 </div>
180 <a id="a8265b710246f9019ff14556adf5eb35a"></a>
181 <h2 class="memtitle"><span class="permalink"><a href="#a8265b710246f9019ff14556adf5eb35a">&#9670;&nbsp;</a></span>calculate_statistics()</h2>
182
183 <div class="memitem">
184 <div class="memproto">
185       <table class="memname">
186         <tr>
187           <td class="memname">std::pair&lt;double, double&gt; calculate_statistics </td>
188           <td>(</td>
189           <td class="paramtype">const std::vector&lt; long &gt;&#160;</td>
190           <td class="paramname"><em>values</em></td><td>)</td>
191           <td></td>
192         </tr>
193       </table>
194 </div><div class="memdoc">
195
196 <p>Calculate the mean and variance from the result of the run_benchmark. </p>
197 <dl class="params"><dt>Parameters</dt><dd>
198   <table class="params">
199     <tr><td class="paramdir">[in]</td><td class="paramname">values</td><td>Vector with result values. </td></tr>
200   </table>
201   </dd>
202 </dl>
203 <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>
204 <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>
205
206 <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>
207 <div class="dynheader">
208 Here is the caller graph for this function:</div>
209 <div class="dyncontent">
210 <div class="center"><img src="common_8cpp_a8265b710246f9019ff14556adf5eb35a_icgraph.png" border="0" usemap="#common_8cpp_a8265b710246f9019ff14556adf5eb35a_icgraph" alt=""/></div>
211 <map name="common_8cpp_a8265b710246f9019ff14556adf5eb35a_icgraph" id="common_8cpp_a8265b710246f9019ff14556adf5eb35a_icgraph">
212 <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"/>
213 <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"/>
214 <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"/>
215 <area shape="rect" id="node4" href="class_kernel_tests.html#adfbe724335d86320c9839c426c4d5715" title="KernelTests::get_reference\l_parameter" alt="" coords="359,71,537,112"/>
216 <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"/>
217 <area shape="rect" id="node7" href="c__plane__tests_8cc.html#a21d05f2c6607fc534e67ed32883de81f" title="TEST_P" alt="" coords="585,137,657,163"/>
218 </map>
219 </div>
220
221 </div>
222 </div>
223 <a id="a39bf4f7770751080f5b72046abfd01a5"></a>
224 <h2 class="memtitle"><span class="permalink"><a href="#a39bf4f7770751080f5b72046abfd01a5">&#9670;&nbsp;</a></span>get_sequence()</h2>
225
226 <div class="memitem">
227 <div class="memproto">
228       <table class="memname">
229         <tr>
230           <td class="memname">std::vector&lt;unsigned&gt; get_sequence </td>
231           <td>(</td>
232           <td class="paramtype">const unsigned&#160;</td>
233           <td class="paramname"><em>number</em></td><td>)</td>
234           <td></td>
235         </tr>
236       </table>
237 </div><div class="memdoc">
238
239 <p>For a given number return sequence of number from 0 to number - 1. </p>
240 <dl class="params"><dt>Parameters</dt><dd>
241   <table class="params">
242     <tr><td class="paramdir">[in]</td><td class="paramname">number</td><td>Positive integer value. </td></tr>
243   </table>
244   </dd>
245 </dl>
246 <dl class="section return"><dt>Returns</dt><dd>Vector with the sorted integer numbers between 0 and number - 1. </dd></dl>
247
248 <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>
249 <div class="dynheader">
250 Here is the caller graph for this function:</div>
251 <div class="dyncontent">
252 <div class="center"><img src="common_8cpp_a39bf4f7770751080f5b72046abfd01a5_icgraph.png" border="0" usemap="#common_8cpp_a39bf4f7770751080f5b72046abfd01a5_icgraph" alt=""/></div>
253 <map name="common_8cpp_a39bf4f7770751080f5b72046abfd01a5_icgraph" id="common_8cpp_a39bf4f7770751080f5b72046abfd01a5_icgraph">
254 <area shape="rect" id="node2" href="c__plane__tests_8cc.html#ab0ad0e23f1b51f15bd9594a24a2c438f" title="TEST_P" alt="" coords="181,5,253,32"/>
255 <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"/>
256 <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"/>
257 <area shape="rect" id="node5" href="class_kernel_tests.html#adfbe724335d86320c9839c426c4d5715" title="KernelTests::get_reference\l_parameter" alt="" coords="327,89,505,130"/>
258 </map>
259 </div>
260
261 </div>
262 </div>
263 <a id="a876ed07783b27d38779f7cef4db673e6"></a>
264 <h2 class="memtitle"><span class="permalink"><a href="#a876ed07783b27d38779f7cef4db673e6">&#9670;&nbsp;</a></span>read_data_to_aligned_array()</h2>
265
266 <div class="memitem">
267 <div class="memproto">
268       <table class="memname">
269         <tr>
270           <td class="memname">char* read_data_to_aligned_array </td>
271           <td>(</td>
272           <td class="paramtype">const std::string &amp;&#160;</td>
273           <td class="paramname"><em>filename</em></td><td>)</td>
274           <td></td>
275         </tr>
276       </table>
277 </div><div class="memdoc">
278
279 <p>Read binary data from the file. </p>
280 <dl class="params"><dt>Parameters</dt><dd>
281   <table class="params">
282     <tr><td class="paramdir">[in]</td><td class="paramname">filename</td><td>name of the binary file. </td></tr>
283   </table>
284   </dd>
285 </dl>
286 <dl class="section return"><dt>Returns</dt><dd>Pointer to the allocated memory with data from the file. </dd></dl>
287 <dl class="exception"><dt>Exceptions</dt><dd>
288   <table class="exception">
289     <tr><td class="paramname">std::runtime_error</td><td>when memory cannot be allocated. </td></tr>
290   </table>
291   </dd>
292 </dl>
293
294 <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>
295 <div class="dynheader">
296 Here is the caller graph for this function:</div>
297 <div class="dyncontent">
298 <div class="center"><img src="common_8cpp_a876ed07783b27d38779f7cef4db673e6_icgraph.png" border="0" usemap="#common_8cpp_a876ed07783b27d38779f7cef4db673e6_icgraph" alt=""/></div>
299 <map name="common_8cpp_a876ed07783b27d38779f7cef4db673e6_icgraph" id="common_8cpp_a876ed07783b27d38779f7cef4db673e6_icgraph">
300 <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"/>
301 <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"/>
302 <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"/>
303 <area shape="rect" id="node4" href="class_kernel_tests.html#adfbe724335d86320c9839c426c4d5715" title="KernelTests::get_reference\l_parameter" alt="" coords="393,71,572,112"/>
304 <area shape="rect" id="node6" href="class_c__plane.html#a3a1707f6479611fdc609a3eb8a0cef1b" title="C_plane::SetUp" alt="" coords="425,137,540,163"/>
305 <area shape="rect" id="node7" href="class_test_chain.html#a3a1707f6479611fdc609a3eb8a0cef1b" title="TestChain::SetUp" alt="" coords="419,187,546,214"/>
306 <area shape="rect" id="node8" href="class_prach_check.html#a3a1707f6479611fdc609a3eb8a0cef1b" title="PrachCheck::SetUp" alt="" coords="413,238,552,265"/>
307 <area shape="rect" id="node9" href="class_prach_perf.html#a3a1707f6479611fdc609a3eb8a0cef1b" title="PrachPerf::SetUp" alt="" coords="420,289,545,315"/>
308 <area shape="rect" id="node10" href="class_u__plane_check.html#a3a1707f6479611fdc609a3eb8a0cef1b" title="U_planeCheck::SetUp" alt="" coords="406,339,559,366"/>
309 <area shape="rect" id="node11" href="class_u__plane_perf.html#a3a1707f6479611fdc609a3eb8a0cef1b" title="U_planePerf::SetUp" alt="" coords="413,390,552,417"/>
310 </map>
311 </div>
312
313 </div>
314 </div>
315 <a id="ad8c062e9b24e4b3a8408b23a0d8ab428"></a>
316 <h2 class="memtitle"><span class="permalink"><a href="#ad8c062e9b24e4b3a8408b23a0d8ab428">&#9670;&nbsp;</a></span>read_json_from_file()</h2>
317
318 <div class="memitem">
319 <div class="memproto">
320       <table class="memname">
321         <tr>
322           <td class="memname"><a class="el" href="common_8hpp.html#ab701e3ac61a85b337ec5c1abaad6742d">json</a> read_json_from_file </td>
323           <td>(</td>
324           <td class="paramtype">const std::string &amp;&#160;</td>
325           <td class="paramname"><em>filename</em></td><td>)</td>
326           <td></td>
327         </tr>
328       </table>
329 </div><div class="memdoc">
330
331 <p>Read JSON from the given file. </p>
332 <dl class="params"><dt>Parameters</dt><dd>
333   <table class="params">
334     <tr><td class="paramdir">[in]</td><td class="paramname">filename</td><td>name of the .json file. </td></tr>
335   </table>
336   </dd>
337 </dl>
338 <dl class="section return"><dt>Returns</dt><dd>JSON object with data. </dd></dl>
339 <dl class="exception"><dt>Exceptions</dt><dd>
340   <table class="exception">
341     <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>
342   </table>
343   </dd>
344 </dl>
345
346 <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>
347 <div class="dynheader">
348 Here is the caller graph for this function:</div>
349 <div class="dyncontent">
350 <div class="center"><img src="common_8cpp_ad8c062e9b24e4b3a8408b23a0d8ab428_icgraph.png" border="0" usemap="#common_8cpp_ad8c062e9b24e4b3a8408b23a0d8ab428_icgraph" alt=""/></div>
351 <map name="common_8cpp_ad8c062e9b24e4b3a8408b23a0d8ab428_icgraph" id="common_8cpp_ad8c062e9b24e4b3a8408b23a0d8ab428_icgraph">
352 <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"/>
353 <area shape="rect" id="node5" href="class_kernel_tests.html#aad8181b222f27240e9f07dcb6e620fa3" title="KernelTests::SetUpTestCase" alt="" coords="190,107,385,134"/>
354 <area shape="rect" id="node6" href="class_kernel_tests.html#a6157ff083be863bba0a7804cd1788d96" title="KernelTests::get_number\l_of_cases" alt="" coords="203,159,371,200"/>
355 <area shape="rect" id="node8" href="classxran_lib_wraper.html#a2e64fc338fcfaac25af91aae564777fa" title="xranLibWraper::xranLibWraper" alt="" coords="188,225,387,251"/>
356 <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"/>
357 <area shape="rect" id="node4" href="class_kernel_tests.html#adfbe724335d86320c9839c426c4d5715" title="KernelTests::get_reference\l_parameter" alt="" coords="435,71,613,112"/>
358 <area shape="rect" id="node7" href="c__plane__tests_8cc.html#ab0ad0e23f1b51f15bd9594a24a2c438f" title="TEST_P" alt="" coords="488,166,560,193"/>
359 </map>
360 </div>
361
362 </div>
363 </div>
364 <a id="a56c41cbb9de4bce25da45ecd74b46a81"></a>
365 <h2 class="memtitle"><span class="permalink"><a href="#a56c41cbb9de4bce25da45ecd74b46a81">&#9670;&nbsp;</a></span>tsc_recovery()</h2>
366
367 <div class="memitem">
368 <div class="memproto">
369       <table class="memname">
370         <tr>
371           <td class="memname">unsigned long tsc_recovery </td>
372           <td>(</td>
373           <td class="paramname"></td><td>)</td>
374           <td></td>
375         </tr>
376       </table>
377 </div><div class="memdoc">
378
379 <p>Measure the TSC on the machine. </p>
380 <dl class="section return"><dt>Returns</dt><dd>Number of ticks per us </dd></dl>
381
382 <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>
383 <div class="dynheader">
384 Here is the call graph for this function:</div>
385 <div class="dyncontent">
386 <div class="center"><img src="common_8cpp_a56c41cbb9de4bce25da45ecd74b46a81_cgraph.png" border="0" usemap="#common_8cpp_a56c41cbb9de4bce25da45ecd74b46a81_cgraph" alt=""/></div>
387 <map name="common_8cpp_a56c41cbb9de4bce25da45ecd74b46a81_cgraph" id="common_8cpp_a56c41cbb9de4bce25da45ecd74b46a81_cgraph">
388 <area shape="rect" id="node2" href="common_8cpp.html#a0ab5719a5f67d4d52057b2c4550fe930" title="Return the current value of the TSC. " alt="" coords="151,5,219,32"/>
389 </map>
390 </div>
391 <div class="dynheader">
392 Here is the caller graph for this function:</div>
393 <div class="dyncontent">
394 <div class="center"><img src="common_8cpp_a56c41cbb9de4bce25da45ecd74b46a81_icgraph.png" border="0" usemap="#common_8cpp_a56c41cbb9de4bce25da45ecd74b46a81_icgraph" alt=""/></div>
395 <map name="common_8cpp_a56c41cbb9de4bce25da45ecd74b46a81_icgraph" id="common_8cpp_a56c41cbb9de4bce25da45ecd74b46a81_icgraph">
396 <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"/>
397 <area shape="rect" id="node5" href="class_kernel_tests.html#aad8181b222f27240e9f07dcb6e620fa3" title="KernelTests::SetUpTestCase" alt="" coords="151,105,345,131"/>
398 <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"/>
399 <area shape="rect" id="node4" href="class_kernel_tests.html#adfbe724335d86320c9839c426c4d5715" title="KernelTests::get_reference\l_parameter" alt="" coords="393,71,572,112"/>
400 </map>
401 </div>
402
403 </div>
404 </div>
405 <a id="a0ab5719a5f67d4d52057b2c4550fe930"></a>
406 <h2 class="memtitle"><span class="permalink"><a href="#a0ab5719a5f67d4d52057b2c4550fe930">&#9670;&nbsp;</a></span>tsc_tick()</h2>
407
408 <div class="memitem">
409 <div class="memproto">
410       <table class="memname">
411         <tr>
412           <td class="memname">unsigned long tsc_tick </td>
413           <td>(</td>
414           <td class="paramname"></td><td>)</td>
415           <td></td>
416         </tr>
417       </table>
418 </div><div class="memdoc">
419
420 <p>Return the current value of the TSC. </p>
421 <dl class="section return"><dt>Returns</dt><dd>Current TSC value </dd></dl>
422
423 <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>
424 <div class="dynheader">
425 Here is the caller graph for this function:</div>
426 <div class="dyncontent">
427 <div class="center"><img src="common_8cpp_a0ab5719a5f67d4d52057b2c4550fe930_icgraph.png" border="0" usemap="#common_8cpp_a0ab5719a5f67d4d52057b2c4550fe930_icgraph" alt=""/></div>
428 <map name="common_8cpp_a0ab5719a5f67d4d52057b2c4550fe930_icgraph" id="common_8cpp_a0ab5719a5f67d4d52057b2c4550fe930_icgraph">
429 <area shape="rect" id="node2" href="common_8hpp.html#a56c41cbb9de4bce25da45ecd74b46a81" title="Measure the TSC on the machine. " alt="" coords="121,95,219,122"/>
430 <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"/>
431 <area shape="rect" id="node6" href="class_kernel_tests.html#aad8181b222f27240e9f07dcb6e620fa3" title="KernelTests::SetUpTestCase" alt="" coords="267,103,461,130"/>
432 <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"/>
433 <area shape="rect" id="node5" href="class_kernel_tests.html#adfbe724335d86320c9839c426c4d5715" title="KernelTests::get_reference\l_parameter" alt="" coords="509,71,688,112"/>
434 </map>
435 </div>
436
437 </div>
438 </div>
439 </div><!-- contents -->
440 <!-- start footer part -->
441 <hr class="footer"/><address class="footer"><small>
442 Generated by &#160;<a href="http://www.doxygen.org/index.html">
443 <img class="footer" src="doxygen.png" alt="doxygen"/>
444 </a> 1.8.13
445 </small></address>
446 </body>
447 </html>