docs/API/structnlohmann_1_1adl__serializer.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: adl_serializer&lt; typename, typename &gt; Struct Template 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="namespacenlohmann.html">nlohmann</a></li><li class="navelem"><a class="el" href="structnlohmann_1_1adl__serializer.html">adl_serializer</a></li>  </ul>
  63 </div>
  64 </div><!-- top -->
  65 <div class="header">
  66   <div class="summary">
  67 <a href="#pub-static-methods">Static Public Member Functions</a>  </div>
  68   <div class="headertitle">
  69 <div class="title">adl_serializer&lt; typename, typename &gt; Struct Template Reference</div>  </div>
  70 </div><!--header-->
  71 <div class="contents">
  72
  73 <p>default JSONSerializer template argument
  74  <a href="structnlohmann_1_1adl__serializer.html#details">More...</a></p>
  75
  76 <p><code>#include &lt;<a class="el" href="json_8hpp_source.html">json.hpp</a>&gt;</code></p>
  77 <div class="dynheader">
  78 Collaboration diagram for adl_serializer&lt; typename, typename &gt;:</div>
  79 <div class="dyncontent">
  80 <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>
  81 </div>
  82 <table class="memberdecls">
  83 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
  84 Static Public Member Functions</h2></td></tr>
  85 <tr class="memitem:adcdd0023173b7ae293da6cc2ffddfd06"><td class="memTemplParams" colspan="2">template&lt;typename BasicJsonType , typename ValueType &gt; </td></tr>
  86 <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>
  87 <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>
  88 <tr class="separator:adcdd0023173b7ae293da6cc2ffddfd06"><td class="memSeparator" colspan="2">&#160;</td></tr>
  89 <tr class="memitem:a1e04b5fee91e47467368f279d7f7b941"><td class="memTemplParams" colspan="2">template&lt;typename BasicJsonType , typename ValueType &gt; </td></tr>
  90 <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>
  91 <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>
  92 <tr class="separator:a1e04b5fee91e47467368f279d7f7b941"><td class="memSeparator" colspan="2">&#160;</td></tr>
  93 </table>
  94 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  95 <div class="textblock"><h3>template&lt;typename = void, typename = void&gt;<br />
  96 struct nlohmann::adl_serializer&lt; typename, typename &gt;</h3>
  97
  98 <p>default JSONSerializer template argument </p>
  99 <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>
 100
 101 <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>
 102 </div><h2 class="groupheader">Member Function Documentation</h2>
 103 <a id="adcdd0023173b7ae293da6cc2ffddfd06"></a>
 104 <h2 class="memtitle"><span class="permalink"><a href="#adcdd0023173b7ae293da6cc2ffddfd06">&#9670;&nbsp;</a></span>from_json()</h2>
 105
 106 <div class="memitem">
 107 <div class="memproto">
 108 <table class="mlabels">
 109   <tr>
 110   <td class="mlabels-left">
 111       <table class="memname">
 112         <tr>
 113           <td class="memname">static void from_json </td>
 114           <td>(</td>
 115           <td class="paramtype">BasicJsonType &amp;&amp;&#160;</td>
 116           <td class="paramname"><em>j</em>, </td>
 117         </tr>
 118         <tr>
 119           <td class="paramkey"></td>
 120           <td></td>
 121           <td class="paramtype">ValueType &amp;&#160;</td>
 122           <td class="paramname"><em>val</em>&#160;</td>
 123         </tr>
 124         <tr>
 125           <td></td>
 126           <td>)</td>
 127           <td></td><td></td>
 128         </tr>
 129       </table>
 130   </td>
 131   <td class="mlabels-right">
 132 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span><span class="mlabel">noexcept</span></span>  </td>
 133   </tr>
 134 </table>
 135 </div><div class="memdoc">
 136
 137 <p>convert a JSON value to any value type </p>
 138 <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>
 139 <dl class="params"><dt>Parameters</dt><dd>
 140   <table class="params">
 141     <tr><td class="paramdir">[in]</td><td class="paramname">j</td><td>JSON value to read from </td></tr>
 142     <tr><td class="paramdir">[in,out]</td><td class="paramname">val</td><td>value to write to </td></tr>
 143   </table>
 144   </dd>
 145 </dl>
 146
 147 <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>
 148 <div class="dynheader">
 149 Here is the call graph for this function:</div>
 150 <div class="dyncontent">
 151 <div class="center"><img src="structnlohmann_1_1adl__serializer_adcdd0023173b7ae293da6cc2ffddfd06_cgraph.png" border="0" usemap="#structnlohmann_1_1adl__serializer_adcdd0023173b7ae293da6cc2ffddfd06_cgraph" alt=""/></div>
 152 <map name="structnlohmann_1_1adl__serializer_adcdd0023173b7ae293da6cc2ffddfd06_cgraph" id="structnlohmann_1_1adl__serializer_adcdd0023173b7ae293da6cc2ffddfd06_cgraph">
 153 <area shape="rect" id="node2" href="namespacenlohmann_1_1detail.html#a839b0ab50d2c9bce669068f56bc41202" title="nlohmann::detail::from_json" alt="" coords="132,5,315,32"/>
 154 </map>
 155 </div>
 156
 157 </div>
 158 </div>
 159 <a id="a1e04b5fee91e47467368f279d7f7b941"></a>
 160 <h2 class="memtitle"><span class="permalink"><a href="#a1e04b5fee91e47467368f279d7f7b941">&#9670;&nbsp;</a></span>to_json()</h2>
 161
 162 <div class="memitem">
 163 <div class="memproto">
 164 <table class="mlabels">
 165   <tr>
 166   <td class="mlabels-left">
 167       <table class="memname">
 168         <tr>
 169           <td class="memname">static void to_json </td>
 170           <td>(</td>
 171           <td class="paramtype">BasicJsonType &amp;&#160;</td>
 172           <td class="paramname"><em>j</em>, </td>
 173         </tr>
 174         <tr>
 175           <td class="paramkey"></td>
 176           <td></td>
 177           <td class="paramtype">ValueType &amp;&amp;&#160;</td>
 178           <td class="paramname"><em>val</em>&#160;</td>
 179         </tr>
 180         <tr>
 181           <td></td>
 182           <td>)</td>
 183           <td></td><td></td>
 184         </tr>
 185       </table>
 186   </td>
 187   <td class="mlabels-right">
 188 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span><span class="mlabel">noexcept</span></span>  </td>
 189   </tr>
 190 </table>
 191 </div><div class="memdoc">
 192
 193 <p>convert any value type to a JSON value </p>
 194 <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>
 195 <dl class="params"><dt>Parameters</dt><dd>
 196   <table class="params">
 197     <tr><td class="paramdir">[in,out]</td><td class="paramname">j</td><td>JSON value to write to </td></tr>
 198     <tr><td class="paramdir">[in]</td><td class="paramname">val</td><td>value to read from </td></tr>
 199   </table>
 200   </dd>
 201 </dl>
 202
 203 <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>
 204 <div class="dynheader">
 205 Here is the call graph for this function:</div>
 206 <div class="dyncontent">
 207 <div class="center"><img src="structnlohmann_1_1adl__serializer_a1e04b5fee91e47467368f279d7f7b941_cgraph.png" border="0" usemap="#structnlohmann_1_1adl__serializer_a1e04b5fee91e47467368f279d7f7b941_cgraph" alt=""/></div>
 208 <map name="structnlohmann_1_1adl__serializer_a1e04b5fee91e47467368f279d7f7b941_cgraph" id="structnlohmann_1_1adl__serializer_a1e04b5fee91e47467368f279d7f7b941_cgraph">
 209 <area shape="rect" id="node2" href="namespacenlohmann_1_1detail.html#a6fa2f784014bfc0b62d7a35d51e676c9" title="nlohmann::detail::to_json" alt="" coords="117,5,284,32"/>
 210 </map>
 211 </div>
 212
 213 </div>
 214 </div>
 215 <hr/>The documentation for this struct was generated from the following file:<ul>
 216 <li><a class="el" href="json_8hpp_source.html">json.hpp</a></li>
 217 </ul>
 218 </div><!-- contents -->
 219 <!-- start footer part -->
 220 <hr class="footer"/><address class="footer"><small>
 221 Generated by &#160;<a href="http://www.doxygen.org/index.html">
 222 <img class="footer" src="doxygen.png" alt="doxygen"/>
 223 </a> 1.8.13
 224 </small></address>
 225 </body>
 226 </html>