add Doxygen documentation
[o-du/phy.git] / docs / API / structreading__input__file__exception.html
diff --git a/docs/API/structreading__input__file__exception.html b/docs/API/structreading__input__file__exception.html
new file mode 100644 (file)
index 0000000..b7c17d1
--- /dev/null
@@ -0,0 +1,158 @@
+<!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: reading_input_file_exception Struct 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><!-- top -->
+<div class="header">
+  <div class="summary">
+<a href="#pub-methods">Public Member Functions</a>  </div>
+  <div class="headertitle">
+<div class="title">reading_input_file_exception Struct Reference</div>  </div>
+</div><!--header-->
+<div class="contents">
+
+<p><code>#include &lt;<a class="el" href="common_8hpp_source.html">common.hpp</a>&gt;</code></p>
+<div class="dynheader">
+Inheritance diagram for reading_input_file_exception:</div>
+<div class="dyncontent">
+<div class="center"><img src="structreading__input__file__exception__inherit__graph.png" border="0" usemap="#reading__input__file__exception_inherit__map" alt="Inheritance graph"/></div>
+</div>
+<div class="dynheader">
+Collaboration diagram for reading_input_file_exception:</div>
+<div class="dyncontent">
+<div class="center"><img src="structreading__input__file__exception__coll__graph.png" border="0" usemap="#reading__input__file__exception_coll__map" alt="Collaboration graph"/></div>
+</div>
+<table class="memberdecls">
+<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
+Public Member Functions</h2></td></tr>
+<tr class="memitem:a70518905d36686ddeeb2eb3b2682f016"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structreading__input__file__exception.html#a70518905d36686ddeeb2eb3b2682f016">what</a> () const override  throw ()</td></tr>
+<tr class="separator:a70518905d36686ddeeb2eb3b2682f016"><td class="memSeparator" colspan="2">&#160;</td></tr>
+</table>
+<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
+<div class="textblock">
+<p class="definition">Definition at line <a class="el" href="common_8hpp_source.html#l00078">78</a> of file <a class="el" href="common_8hpp_source.html">common.hpp</a>.</p>
+</div><h2 class="groupheader">Member Function Documentation</h2>
+<a id="a70518905d36686ddeeb2eb3b2682f016"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a70518905d36686ddeeb2eb3b2682f016">&#9670;&nbsp;</a></span>what()</h2>
+
+<div class="memitem">
+<div class="memproto">
+<table class="mlabels">
+  <tr>
+  <td class="mlabels-left">
+      <table class="memname">
+        <tr>
+          <td class="memname">const char* what </td>
+          <td>(</td>
+          <td class="paramname"></td><td>)</td>
+          <td> const</td>
+        </tr>
+        <tr>
+          <td align="right">throw </td><td>(</td><td colspan="2"></td>
+        </tr>
+        <tr>
+          <td align="right"></td><td>)</td><td></td><td></td>
+        </tr>
+      </table>
+  </td>
+  <td class="mlabels-right">
+<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span></span>  </td>
+  </tr>
+</table>
+</div><div class="memdoc">
+
+<p class="definition">Definition at line <a class="el" href="common_8hpp_source.html#l00080">80</a> of file <a class="el" href="common_8hpp_source.html">common.hpp</a>.</p>
+<div class="dynheader">
+Here is the call graph for this function:</div>
+<div class="dyncontent">
+<div class="center"><img src="structreading__input__file__exception_a70518905d36686ddeeb2eb3b2682f016_cgraph.png" border="0" usemap="#structreading__input__file__exception_a70518905d36686ddeeb2eb3b2682f016_cgraph" alt=""/></div>
+<map name="structreading__input__file__exception_a70518905d36686ddeeb2eb3b2682f016_cgraph" id="structreading__input__file__exception_a70518905d36686ddeeb2eb3b2682f016_cgraph">
+<area shape="rect" id="node2" href="common_8hpp.html#ae39390f41ba978a1f0d79691436c074a" title="Attach current process to the selected core. " alt="" coords="131,5,223,32"/>
+<area shape="rect" id="node3" href="common_8hpp.html#a8265b710246f9019ff14556adf5eb35a" title="Calculate the mean and variance from the result of the run_benchmark. " alt="" coords="109,56,244,83"/>
+<area shape="rect" id="node4" href="common_8hpp.html#a39bf4f7770751080f5b72046abfd01a5" title="For a given number return sequence of number from 0 to number &#45; 1. " alt="" coords="125,107,228,133"/>
+<area shape="rect" id="node5" href="common_8hpp.html#ad8c062e9b24e4b3a8408b23a0d8ab428" title="Read JSON from the given file. " alt="" coords="109,157,244,184"/>
+<area shape="rect" id="node6" href="common_8hpp.html#a876ed07783b27d38779f7cef4db673e6" title="Read binary data from the file. " alt="" coords="104,209,249,250"/>
+<area shape="rect" id="node7" href="common_8hpp.html#a56c41cbb9de4bce25da45ecd74b46a81" title="Measure the TSC on the machine. " alt="" coords="128,275,225,301"/>
+<area shape="rect" id="node9" href="common_8hpp.html#a0ab5719a5f67d4d52057b2c4550fe930" title="Return the current value of the TSC. " alt="" coords="143,325,211,352"/>
+<area shape="rect" id="node8" href="common_8cpp.html#a0ab5719a5f67d4d52057b2c4550fe930" title="Return the current value of the TSC. " alt="" coords="297,275,365,301"/>
+</map>
+</div>
+<div class="dynheader">
+Here is the caller graph for this function:</div>
+<div class="dyncontent">
+<div class="center"><img src="structreading__input__file__exception_a70518905d36686ddeeb2eb3b2682f016_icgraph.png" border="0" usemap="#structreading__input__file__exception_a70518905d36686ddeeb2eb3b2682f016_icgraph" alt=""/></div>
+<map name="structreading__input__file__exception_a70518905d36686ddeeb2eb3b2682f016_icgraph" id="structreading__input__file__exception_a70518905d36686ddeeb2eb3b2682f016_icgraph">
+<area shape="rect" id="node2" 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="117,5,270,47"/>
+<area shape="rect" id="node3" href="class_kernel_tests.html#adfbe724335d86320c9839c426c4d5715" title="KernelTests::get_reference\l_parameter" alt="" coords="104,71,283,112"/>
+</map>
+</div>
+
+</div>
+</div>
+<hr/>The documentation for this struct was generated from the following file:<ul>
+<li><a class="el" href="common_8hpp_source.html">common.hpp</a></li>
+</ul>
+</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>