blob: 73ec006cf9c5c7ded024d52be92b0e22924b87ef [file] [log] [blame]
<!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::JSONReader 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_1JSONReader.html">JSONReader</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classdmlc_1_1JSONReader-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">dmlc::JSONReader Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Lightweight JSON Reader to read any STL compositions and structs. The user need to know the schema of the.
<a href="classdmlc_1_1JSONReader.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="json_8h_source.html">json.h</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for dmlc::JSONReader:</div>
<div class="dyncontent">
<div class="center"><img src="classdmlc_1_1JSONReader__coll__graph.png" border="0" usemap="#dmlc_1_1JSONReader_coll__map" alt="Collaboration graph"/></div>
<map name="dmlc_1_1JSONReader_coll__map" id="dmlc_1_1JSONReader_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:a722e2c409ccac6e1b4b8a06c145dd40f"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1JSONReader.html#a722e2c409ccac6e1b4b8a06c145dd40f">JSONReader</a> (std::istream *is)</td></tr>
<tr class="memdesc:a722e2c409ccac6e1b4b8a06c145dd40f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor. <a href="#a722e2c409ccac6e1b4b8a06c145dd40f">More...</a><br /></td></tr>
<tr class="separator:a722e2c409ccac6e1b4b8a06c145dd40f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4dd8dff75faccda0b0be5ecfd57a6fc8"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1JSONReader.html#a4dd8dff75faccda0b0be5ecfd57a6fc8">ReadString</a> (std::string *out_str)</td></tr>
<tr class="memdesc:a4dd8dff75faccda0b0be5ecfd57a6fc8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Parse next JSON string. <a href="#a4dd8dff75faccda0b0be5ecfd57a6fc8">More...</a><br /></td></tr>
<tr class="separator:a4dd8dff75faccda0b0be5ecfd57a6fc8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a993579a90fcd674e171b2a37e3ada640"><td class="memTemplParams" colspan="2">template&lt;typename ValueType &gt; </td></tr>
<tr class="memitem:a993579a90fcd674e171b2a37e3ada640"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classdmlc_1_1JSONReader.html#a993579a90fcd674e171b2a37e3ada640">ReadNumber</a> (ValueType *out_value)</td></tr>
<tr class="memdesc:a993579a90fcd674e171b2a37e3ada640"><td class="mdescLeft">&#160;</td><td class="mdescRight">Read Number. <a href="#a993579a90fcd674e171b2a37e3ada640">More...</a><br /></td></tr>
<tr class="separator:a993579a90fcd674e171b2a37e3ada640"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9d8b4e994ecf2f084ecdac6e98aa3ddc"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1JSONReader.html#a9d8b4e994ecf2f084ecdac6e98aa3ddc">BeginObject</a> ()</td></tr>
<tr class="memdesc:a9d8b4e994ecf2f084ecdac6e98aa3ddc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Begin parsing an object. <a href="#a9d8b4e994ecf2f084ecdac6e98aa3ddc">More...</a><br /></td></tr>
<tr class="separator:a9d8b4e994ecf2f084ecdac6e98aa3ddc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4fbe59aae3ae33d977dfda6b4a692d53"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1JSONReader.html#a4fbe59aae3ae33d977dfda6b4a692d53">BeginArray</a> ()</td></tr>
<tr class="memdesc:a4fbe59aae3ae33d977dfda6b4a692d53"><td class="mdescLeft">&#160;</td><td class="mdescRight">Begin parsing an array. <a href="#a4fbe59aae3ae33d977dfda6b4a692d53">More...</a><br /></td></tr>
<tr class="separator:a4fbe59aae3ae33d977dfda6b4a692d53"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a25147ca3ef83c7f1ec116606ba94f1c5"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1JSONReader.html#a25147ca3ef83c7f1ec116606ba94f1c5">NextObjectItem</a> (std::string *out_key)</td></tr>
<tr class="memdesc:a25147ca3ef83c7f1ec116606ba94f1c5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Try to move to next object item. If this call is successful, user can proceed to call reader-&gt;Read to read in the value. <a href="#a25147ca3ef83c7f1ec116606ba94f1c5">More...</a><br /></td></tr>
<tr class="separator:a25147ca3ef83c7f1ec116606ba94f1c5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1c643975e6f01ce0a96a691587e90707"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1JSONReader.html#a1c643975e6f01ce0a96a691587e90707">NextArrayItem</a> ()</td></tr>
<tr class="memdesc:a1c643975e6f01ce0a96a691587e90707"><td class="mdescLeft">&#160;</td><td class="mdescRight">Try to read the next element in the array. If this call is successful, user can proceed to call reader-&gt;Read to read in the value. <a href="#a1c643975e6f01ce0a96a691587e90707">More...</a><br /></td></tr>
<tr class="separator:a1c643975e6f01ce0a96a691587e90707"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a74487e106bca0cc16b676f539f69a4bf"><td class="memTemplParams" colspan="2">template&lt;typename ValueType &gt; </td></tr>
<tr class="memitem:a74487e106bca0cc16b676f539f69a4bf"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classdmlc_1_1JSONReader.html#a74487e106bca0cc16b676f539f69a4bf">Read</a> (ValueType *out_value)</td></tr>
<tr class="memdesc:a74487e106bca0cc16b676f539f69a4bf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Read next ValueType. <a href="#a74487e106bca0cc16b676f539f69a4bf">More...</a><br /></td></tr>
<tr class="separator:a74487e106bca0cc16b676f539f69a4bf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1269d63cd681afa6cf74705f07985a76"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1JSONReader.html#a1269d63cd681afa6cf74705f07985a76">line_info</a> () const</td></tr>
<tr class="separator:a1269d63cd681afa6cf74705f07985a76"><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>Lightweight JSON Reader to read any STL compositions and structs. The user need to know the schema of the. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a722e2c409ccac6e1b4b8a06c145dd40f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a722e2c409ccac6e1b4b8a06c145dd40f">&#9670;&nbsp;</a></span>JSONReader()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">dmlc::JSONReader::JSONReader </td>
<td>(</td>
<td class="paramtype">std::istream *&#160;</td>
<td class="paramname"><em>is</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">explicit</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructor. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">is</td><td>the input source. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a4fbe59aae3ae33d977dfda6b4a692d53"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4fbe59aae3ae33d977dfda6b4a692d53">&#9670;&nbsp;</a></span>BeginArray()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void dmlc::JSONReader::BeginArray </td>
<td>(</td>
<td class="paramname"></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>Begin parsing an array. </p>
<div class="fragment"><div class="line"><span class="comment">// value can be any type that is json serializable.</span></div><div class="line">std::string value;</div><div class="line">reader-&gt;<a class="code" href="classdmlc_1_1JSONReader.html#a4fbe59aae3ae33d977dfda6b4a692d53">BeginArray</a>();</div><div class="line"><span class="keywordflow">while</span> (reader-&gt;<a class="code" href="classdmlc_1_1JSONReader.html#a1c643975e6f01ce0a96a691587e90707">NextArrayItem</a>()) {</div><div class="line"> reader-&gt;<a class="code" href="classdmlc_1_1JSONReader.html#a74487e106bca0cc16b676f539f69a4bf">Read</a>(&amp;value);</div><div class="line"> <span class="comment">// do somthing to value</span></div><div class="line">}</div></div><!-- fragment -->
</div>
</div>
<a id="a9d8b4e994ecf2f084ecdac6e98aa3ddc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9d8b4e994ecf2f084ecdac6e98aa3ddc">&#9670;&nbsp;</a></span>BeginObject()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void dmlc::JSONReader::BeginObject </td>
<td>(</td>
<td class="paramname"></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>Begin parsing an object. </p>
<div class="fragment"><div class="line">std::string key;</div><div class="line"><span class="comment">// value can be any type that is json serializable.</span></div><div class="line">std::string value;</div><div class="line">reader-&gt;<a class="code" href="classdmlc_1_1JSONReader.html#a9d8b4e994ecf2f084ecdac6e98aa3ddc">BeginObject</a>();</div><div class="line"><span class="keywordflow">while</span> (reader-&gt;<a class="code" href="classdmlc_1_1JSONReader.html#a25147ca3ef83c7f1ec116606ba94f1c5">NextObjectItem</a>(&amp;key)) {</div><div class="line"> <span class="comment">// do somthing to key value</span></div><div class="line"> reader-&gt;<a class="code" href="classdmlc_1_1JSONReader.html#a74487e106bca0cc16b676f539f69a4bf">Read</a>(&amp;value);</div><div class="line">}</div></div><!-- fragment -->
</div>
</div>
<a id="a1269d63cd681afa6cf74705f07985a76"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1269d63cd681afa6cf74705f07985a76">&#9670;&nbsp;</a></span>line_info()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::string dmlc::JSONReader::line_info </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>current line count </dd></dl>
</div>
</div>
<a id="a1c643975e6f01ce0a96a691587e90707"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1c643975e6f01ce0a96a691587e90707">&#9670;&nbsp;</a></span>NextArrayItem()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool dmlc::JSONReader::NextArrayItem </td>
<td>(</td>
<td class="paramname"></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>Try to read the next element in the array. If this call is successful, user can proceed to call reader-&gt;Read to read in the value. </p>
<dl class="section return"><dt>Returns</dt><dd>true if the read is successful, false if we are at end of the array. </dd></dl>
</div>
</div>
<a id="a25147ca3ef83c7f1ec116606ba94f1c5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a25147ca3ef83c7f1ec116606ba94f1c5">&#9670;&nbsp;</a></span>NextObjectItem()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool dmlc::JSONReader::NextObjectItem </td>
<td>(</td>
<td class="paramtype">std::string *&#160;</td>
<td class="paramname"><em>out_key</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>Try to move to next object item. If this call is successful, user can proceed to call reader-&gt;Read to read in the value. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">out_key</td><td>the key to the next object. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if the read is successful, false if we are at end of the object. </dd></dl>
</div>
</div>
<a id="a74487e106bca0cc16b676f539f69a4bf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a74487e106bca0cc16b676f539f69a4bf">&#9670;&nbsp;</a></span>Read()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename ValueType &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void dmlc::JSONReader::Read </td>
<td>(</td>
<td class="paramtype">ValueType *&#160;</td>
<td class="paramname"><em>out_value</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 next ValueType. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">out_value</td><td>any STL or json readable type to be read </td></tr>
</table>
</dd>
</dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname">dmlc::Error</td><td>when the read of ValueType is not successful. </td></tr>
</table>
</dd>
</dl>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">ValueType</td><td>the data type to be read. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a993579a90fcd674e171b2a37e3ada640"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a993579a90fcd674e171b2a37e3ada640">&#9670;&nbsp;</a></span>ReadNumber()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename ValueType &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void dmlc::JSONReader::ReadNumber </td>
<td>(</td>
<td class="paramtype">ValueType *&#160;</td>
<td class="paramname"><em>out_value</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 Number. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">out_value</td><td>output value; </td></tr>
</table>
</dd>
</dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname">dmlc::Error</td><td>when next token is not number of ValueType. </td></tr>
</table>
</dd>
</dl>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">ValueType</td><td>type of the number </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a4dd8dff75faccda0b0be5ecfd57a6fc8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4dd8dff75faccda0b0be5ecfd57a6fc8">&#9670;&nbsp;</a></span>ReadString()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void dmlc::JSONReader::ReadString </td>
<td>(</td>
<td class="paramtype">std::string *&#160;</td>
<td class="paramname"><em>out_str</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>Parse next JSON string. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">out_str</td><td>the output string. </td></tr>
</table>
</dd>
</dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname">dmlc::Error</td><td>when next token is not string </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 &#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>