| <!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>mxnet: dmlc::JSONObjectReadHelper Class 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">mxnet |
| </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="namespacedmlc.html">dmlc</a></li><li class="navelem"><a class="el" href="classdmlc_1_1JSONObjectReadHelper.html">JSONObjectReadHelper</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#nested-classes">Classes</a> | |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="classdmlc_1_1JSONObjectReadHelper-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">dmlc::JSONObjectReadHelper Class Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>Helper class to read JSON into a class or struct object. |
| <a href="classdmlc_1_1JSONObjectReadHelper.html#details">More...</a></p> |
| |
| <p><code>#include <<a class="el" href="json_8h_source.html">json.h</a>></code></p> |
| <div class="dynheader"> |
| Collaboration diagram for dmlc::JSONObjectReadHelper:</div> |
| <div class="dyncontent"> |
| <div class="center"><img src="classdmlc_1_1JSONObjectReadHelper__coll__graph.png" border="0" usemap="#dmlc_1_1JSONObjectReadHelper_coll__map" alt="Collaboration graph"/></div> |
| <map name="dmlc_1_1JSONObjectReadHelper_coll__map" id="dmlc_1_1JSONObjectReadHelper_coll__map"> |
| </map> |
| </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:ab259f62a8ecab2047f251a11d0ea1ebe"><td class="memTemplParams" colspan="2">template<typename T > </td></tr> |
| <tr class="memitem:ab259f62a8ecab2047f251a11d0ea1ebe"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classdmlc_1_1JSONObjectReadHelper.html#ab259f62a8ecab2047f251a11d0ea1ebe">DeclareField</a> (const std::string &key, T *addr)</td></tr> |
| <tr class="memdesc:ab259f62a8ecab2047f251a11d0ea1ebe"><td class="mdescLeft"> </td><td class="mdescRight">Declare field of type T. <a href="#ab259f62a8ecab2047f251a11d0ea1ebe">More...</a><br /></td></tr> |
| <tr class="separator:ab259f62a8ecab2047f251a11d0ea1ebe"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ad66adc131bc471ff92896d6bb5be6c2d"><td class="memTemplParams" colspan="2">template<typename T > </td></tr> |
| <tr class="memitem:ad66adc131bc471ff92896d6bb5be6c2d"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classdmlc_1_1JSONObjectReadHelper.html#ad66adc131bc471ff92896d6bb5be6c2d">DeclareOptionalField</a> (const std::string &key, T *addr)</td></tr> |
| <tr class="memdesc:ad66adc131bc471ff92896d6bb5be6c2d"><td class="mdescLeft"> </td><td class="mdescRight">Declare optional field of type T. <a href="#ad66adc131bc471ff92896d6bb5be6c2d">More...</a><br /></td></tr> |
| <tr class="separator:ad66adc131bc471ff92896d6bb5be6c2d"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a0672fc70569c72d0c5fae7d4b61704ab"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1JSONObjectReadHelper.html#a0672fc70569c72d0c5fae7d4b61704ab">ReadAllFields</a> (<a class="el" href="classdmlc_1_1JSONReader.html">JSONReader</a> *reader)</td></tr> |
| <tr class="memdesc:a0672fc70569c72d0c5fae7d4b61704ab"><td class="mdescLeft"> </td><td class="mdescRight">Read in all the declared fields. <a href="#a0672fc70569c72d0c5fae7d4b61704ab">More...</a><br /></td></tr> |
| <tr class="separator:a0672fc70569c72d0c5fae7d4b61704ab"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>Helper class to read JSON into a class or struct object. </p> |
| <div class="fragment"><div class="line"><span class="keyword">struct </span>Param {</div><div class="line"> std::string name;</div><div class="line"> <span class="keywordtype">int</span> value;</div><div class="line"> <span class="comment">// define load function from JSON</span></div><div class="line"> <span class="keyword">inline</span> <span class="keywordtype">void</span> Load(<a class="code" href="classdmlc_1_1JSONReader.html">dmlc::JSONReader</a> *reader) {</div><div class="line"> dmlc::JSONStructReadHelper helper;</div><div class="line"> helper.DeclareField(<span class="stringliteral">"name"</span>, &name);</div><div class="line"> helper.DeclareField(<span class="stringliteral">"value"</span>, &value);</div><div class="line"> helper.ReadAllFields(reader);</div><div class="line"> }</div><div class="line">};</div></div><!-- fragment --> </div><h2 class="groupheader">Member Function Documentation</h2> |
| <a id="ab259f62a8ecab2047f251a11d0ea1ebe"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ab259f62a8ecab2047f251a11d0ea1ebe">◆ </a></span>DeclareField()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<typename T > </div> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void dmlc::JSONObjectReadHelper::DeclareField </td> |
| <td>(</td> |
| <td class="paramtype">const std::string & </td> |
| <td class="paramname"><em>key</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">T * </td> |
| <td class="paramname"><em>addr</em> </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> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Declare field of type T. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">key</td><td>the key of the of field. </td></tr> |
| <tr><td class="paramname">addr</td><td>address of the data type. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="tparams"><dt>Template Parameters</dt><dd> |
| <table class="tparams"> |
| <tr><td class="paramname">T</td><td>the data type to be read, must be STL composition of JSON serializable. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="ad66adc131bc471ff92896d6bb5be6c2d"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ad66adc131bc471ff92896d6bb5be6c2d">◆ </a></span>DeclareOptionalField()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<typename T > </div> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void dmlc::JSONObjectReadHelper::DeclareOptionalField </td> |
| <td>(</td> |
| <td class="paramtype">const std::string & </td> |
| <td class="paramname"><em>key</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">T * </td> |
| <td class="paramname"><em>addr</em> </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> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Declare optional field of type T. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">key</td><td>the key of the of field. </td></tr> |
| <tr><td class="paramname">addr</td><td>address of the data type. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="tparams"><dt>Template Parameters</dt><dd> |
| <table class="tparams"> |
| <tr><td class="paramname">T</td><td>the data type to be read, must be STL composition of JSON serializable. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="a0672fc70569c72d0c5fae7d4b61704ab"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a0672fc70569c72d0c5fae7d4b61704ab">◆ </a></span>ReadAllFields()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void dmlc::JSONObjectReadHelper::ReadAllFields </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="classdmlc_1_1JSONReader.html">JSONReader</a> * </td> |
| <td class="paramname"><em>reader</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Read in all the declared fields. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">reader</td><td>the <a class="el" href="classdmlc_1_1JSONReader.html" title="Lightweight JSON Reader to read any STL compositions and structs. The user need to know the schema of...">JSONReader</a> to read the json. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following file:<ul> |
| <li>/work/mxnet/3rdparty/dmlc-core/include/dmlc/<a class="el" href="json_8h_source.html">json.h</a></li> |
| </ul> |
| </div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated on Thu Jan 5 2023 00:58:43 for mxnet by  <a href="http://www.doxygen.org/index.html"> |
| <img class="footer" src="doxygen.png" alt="doxygen"/> |
| </a> 1.8.13 |
| </small></address> |
| </body> |
| </html> |
