add Doxygen documentation
[o-du/phy.git] / docs / API / structnlohmann_1_1adl__serializer.html
diff --git a/docs/API/structnlohmann_1_1adl__serializer.html b/docs/API/structnlohmann_1_1adl__serializer.html
new file mode 100644 (file)
index 0000000..77199f5
--- /dev/null
@@ -0,0 +1,226 @@
+<!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: adl_serializer&lt; typename, typename &gt; Struct Template 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="namespacenlohmann.html">nlohmann</a></li><li class="navelem"><a class="el" href="structnlohmann_1_1adl__serializer.html">adl_serializer</a></li>  </ul>
+</div>
+</div><!-- top -->
+<div class="header">
+  <div class="summary">
+<a href="#pub-static-methods">Static Public Member Functions</a>  </div>
+  <div class="headertitle">
+<div class="title">adl_serializer&lt; typename, typename &gt; Struct Template Reference</div>  </div>
+</div><!--header-->
+<div class="contents">
+
+<p>default JSONSerializer template argument  
+ <a href="structnlohmann_1_1adl__serializer.html#details">More...</a></p>
+
+<p><code>#include &lt;<a class="el" href="json_8hpp_source.html">json.hpp</a>&gt;</code></p>
+<div class="dynheader">
+Collaboration diagram for adl_serializer&lt; typename, typename &gt;:</div>
+<div class="dyncontent">
+<div class="center"><img src="structnlohmann_1_1adl__serializer__coll__graph.png" border="0" usemap="#adl__serializer_3_01typename_00_01typename_01_4_coll__map" alt="Collaboration graph"/></div>
+</div>
+<table class="memberdecls">
+<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
+Static Public Member Functions</h2></td></tr>
+<tr class="memitem:adcdd0023173b7ae293da6cc2ffddfd06"><td class="memTemplParams" colspan="2">template&lt;typename BasicJsonType , typename ValueType &gt; </td></tr>
+<tr class="memitem:adcdd0023173b7ae293da6cc2ffddfd06"><td class="memTemplItemLeft" align="right" valign="top">static void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="structnlohmann_1_1adl__serializer.html#adcdd0023173b7ae293da6cc2ffddfd06">from_json</a> (BasicJsonType &amp;&amp;j, ValueType &amp;val) noexcept(noexcept(::nlohmann::from_json(std::forward&lt; BasicJsonType &gt;(j), val)))</td></tr>
+<tr class="memdesc:adcdd0023173b7ae293da6cc2ffddfd06"><td class="mdescLeft">&#160;</td><td class="mdescRight">convert a JSON value to any value type  <a href="#adcdd0023173b7ae293da6cc2ffddfd06">More...</a><br /></td></tr>
+<tr class="separator:adcdd0023173b7ae293da6cc2ffddfd06"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a1e04b5fee91e47467368f279d7f7b941"><td class="memTemplParams" colspan="2">template&lt;typename BasicJsonType , typename ValueType &gt; </td></tr>
+<tr class="memitem:a1e04b5fee91e47467368f279d7f7b941"><td class="memTemplItemLeft" align="right" valign="top">static void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="structnlohmann_1_1adl__serializer.html#a1e04b5fee91e47467368f279d7f7b941">to_json</a> (BasicJsonType &amp;j, ValueType &amp;&amp;val) noexcept(noexcept(::nlohmann::to_json(j, std::forward&lt; ValueType &gt;(val))))</td></tr>
+<tr class="memdesc:a1e04b5fee91e47467368f279d7f7b941"><td class="mdescLeft">&#160;</td><td class="mdescRight">convert any value type to a JSON value  <a href="#a1e04b5fee91e47467368f279d7f7b941">More...</a><br /></td></tr>
+<tr class="separator:a1e04b5fee91e47467368f279d7f7b941"><td class="memSeparator" colspan="2">&#160;</td></tr>
+</table>
+<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
+<div class="textblock"><h3>template&lt;typename = void, typename = void&gt;<br />
+struct nlohmann::adl_serializer&lt; typename, typename &gt;</h3>
+
+<p>default JSONSerializer template argument </p>
+<p>This serializer ignores the template arguments and uses ADL (<a href="http://en.cppreference.com/w/cpp/language/adl">argument-dependent lookup</a>) for serialization. </p>
+
+<p class="definition">Definition at line <a class="el" href="json_8hpp_source.html#l00888">888</a> of file <a class="el" href="json_8hpp_source.html">json.hpp</a>.</p>
+</div><h2 class="groupheader">Member Function Documentation</h2>
+<a id="adcdd0023173b7ae293da6cc2ffddfd06"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#adcdd0023173b7ae293da6cc2ffddfd06">&#9670;&nbsp;</a></span>from_json()</h2>
+
+<div class="memitem">
+<div class="memproto">
+<table class="mlabels">
+  <tr>
+  <td class="mlabels-left">
+      <table class="memname">
+        <tr>
+          <td class="memname">static void from_json </td>
+          <td>(</td>
+          <td class="paramtype">BasicJsonType &amp;&amp;&#160;</td>
+          <td class="paramname"><em>j</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">ValueType &amp;&#160;</td>
+          <td class="paramname"><em>val</em>&#160;</td>
+        </tr>
+        <tr>
+          <td></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">static</span><span class="mlabel">noexcept</span></span>  </td>
+  </tr>
+</table>
+</div><div class="memdoc">
+
+<p>convert a JSON value to any value type </p>
+<p>This function is usually called by the <code>get()</code> function of the <a class="el" href="classnlohmann_1_1basic__json.html">basic_json</a> class (either explicit or via conversion operators).</p>
+<dl class="params"><dt>Parameters</dt><dd>
+  <table class="params">
+    <tr><td class="paramdir">[in]</td><td class="paramname">j</td><td>JSON value to read from </td></tr>
+    <tr><td class="paramdir">[in,out]</td><td class="paramname">val</td><td>value to write to </td></tr>
+  </table>
+  </dd>
+</dl>
+
+<p class="definition">Definition at line <a class="el" href="json_8hpp_source.html#l00900">900</a> of file <a class="el" href="json_8hpp_source.html">json.hpp</a>.</p>
+<div class="dynheader">
+Here is the call graph for this function:</div>
+<div class="dyncontent">
+<div class="center"><img src="structnlohmann_1_1adl__serializer_adcdd0023173b7ae293da6cc2ffddfd06_cgraph.png" border="0" usemap="#structnlohmann_1_1adl__serializer_adcdd0023173b7ae293da6cc2ffddfd06_cgraph" alt=""/></div>
+<map name="structnlohmann_1_1adl__serializer_adcdd0023173b7ae293da6cc2ffddfd06_cgraph" id="structnlohmann_1_1adl__serializer_adcdd0023173b7ae293da6cc2ffddfd06_cgraph">
+<area shape="rect" id="node2" href="namespacenlohmann_1_1detail.html#a839b0ab50d2c9bce669068f56bc41202" title="nlohmann::detail::from_json" alt="" coords="132,5,315,32"/>
+</map>
+</div>
+
+</div>
+</div>
+<a id="a1e04b5fee91e47467368f279d7f7b941"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a1e04b5fee91e47467368f279d7f7b941">&#9670;&nbsp;</a></span>to_json()</h2>
+
+<div class="memitem">
+<div class="memproto">
+<table class="mlabels">
+  <tr>
+  <td class="mlabels-left">
+      <table class="memname">
+        <tr>
+          <td class="memname">static void to_json </td>
+          <td>(</td>
+          <td class="paramtype">BasicJsonType &amp;&#160;</td>
+          <td class="paramname"><em>j</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">ValueType &amp;&amp;&#160;</td>
+          <td class="paramname"><em>val</em>&#160;</td>
+        </tr>
+        <tr>
+          <td></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">static</span><span class="mlabel">noexcept</span></span>  </td>
+  </tr>
+</table>
+</div><div class="memdoc">
+
+<p>convert any value type to a JSON value </p>
+<p>This function is usually called by the constructors of the <a class="el" href="classnlohmann_1_1basic__json.html">basic_json</a> class.</p>
+<dl class="params"><dt>Parameters</dt><dd>
+  <table class="params">
+    <tr><td class="paramdir">[in,out]</td><td class="paramname">j</td><td>JSON value to write to </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">val</td><td>value to read from </td></tr>
+  </table>
+  </dd>
+</dl>
+
+<p class="definition">Definition at line <a class="el" href="json_8hpp_source.html#l00916">916</a> of file <a class="el" href="json_8hpp_source.html">json.hpp</a>.</p>
+<div class="dynheader">
+Here is the call graph for this function:</div>
+<div class="dyncontent">
+<div class="center"><img src="structnlohmann_1_1adl__serializer_a1e04b5fee91e47467368f279d7f7b941_cgraph.png" border="0" usemap="#structnlohmann_1_1adl__serializer_a1e04b5fee91e47467368f279d7f7b941_cgraph" alt=""/></div>
+<map name="structnlohmann_1_1adl__serializer_a1e04b5fee91e47467368f279d7f7b941_cgraph" id="structnlohmann_1_1adl__serializer_a1e04b5fee91e47467368f279d7f7b941_cgraph">
+<area shape="rect" id="node2" href="namespacenlohmann_1_1detail.html#a6fa2f784014bfc0b62d7a35d51e676c9" title="nlohmann::detail::to_json" alt="" coords="117,5,284,32"/>
+</map>
+</div>
+
+</div>
+</div>
+<hr/>The documentation for this struct was generated from the following file:<ul>
+<li><a class="el" href="json_8hpp_source.html">json.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>