External/json
8
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
2ce09a35ab
json/classnlohmann_1_1basic__json_af4261341695729a8e657b94772f95516.html

171 lines
10 KiB
HTML
Raw Normal View History

Update
2015-06-21 22:43:30 +03:00
<!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.9.1"/>
<title>JSON for Modern C++: nlohmann::basic_json::begin</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="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</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>
<script type="text/javascript">
$(document).ready(function() { init_search(); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="mylayout.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 style="padding-left: 0.5em;">
<div id="projectname">JSON for Modern C++
&#160;<span id="projectnumber">3.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.9.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('classnlohmann_1_1basic__json_af4261341695729a8e657b94772f95516.html','');});
</script>
<div id="doc-content">
<!-- 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 class="contents">
<a class="anchor" id="af4261341695729a8e657b94772f95516"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;template&lt; typename U, typename V, typename...Args &gt; class ObjectType = std::map, template&lt; typename U, typename...Args &gt; class ArrayType = std::vector, class StringType = std::string, class BooleanType = bool, class NumberIntegerType = int64_t, class NumberFloatType = double, template&lt; typename U &gt; class AllocatorType = std::allocator&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classnlohmann_1_1basic__json_1_1iterator.html">iterator</a> <a class="el" href="classnlohmann_1_1basic__json.html">nlohmann::basic_json</a>::begin </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 class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns an iterator to the first element.</p>
<div class="image">
<img src="range-begin-end.svg" alt="range-begin-end.svg"/>
<div class="caption">
Illustration from cppreference.com</div></div>
<dl class="section return"><dt>Returns</dt><dd>iterator to the first element</dd></dl>
<dl class="section user"><dt>Complexity</dt><dd>Constant.</dd></dl>
<dl class="section user"><dt>Requirements</dt><dd>This function satisfies the Container requirements:<ul>
<li>The complexity is constant.</li>
</ul>
</dd></dl>
<dl class="section user"><dt>Example</dt><dd>The following code shows an example for <a class="el" href="classnlohmann_1_1basic__json_af4261341695729a8e657b94772f95516.html#af4261341695729a8e657b94772f95516">begin</a>. <div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="preprocessor">#include &lt;json.hpp&gt;</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;</div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="keyword">using namespace </span><a class="code" href="namespacenlohmann.html">nlohmann</a>;</div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;</div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="keywordtype">int</span> main()</div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;{</div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160; <span class="comment">// create an array value</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160; <a class="code" href="classnlohmann_1_1basic__json.html">json</a> <a class="code" href="classnlohmann_1_1basic__json_a53590b99e380c464a83a0a5edf6da9ab.html#a53590b99e380c464a83a0a5edf6da9ab">array</a> = {1, 2, 3, 4, 5};</div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;</div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160; <span class="comment">// get am iterator to the first element</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160; <a class="code" href="classnlohmann_1_1basic__json_1_1iterator.html">json::iterator</a> it = array.<a class="code" href="classnlohmann_1_1basic__json_af4261341695729a8e657b94772f95516.html#af4261341695729a8e657b94772f95516">begin</a>();</div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;</div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160; <span class="comment">// serialize the element that the iterator points to</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160; std::cout &lt;&lt; *it &lt;&lt; <span class="charliteral">&#39;\n&#39;</span>;</div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;}</div>
<div class="ttc" id="classnlohmann_1_1basic__json_html"><div class="ttname"><a href="classnlohmann_1_1basic__json.html">nlohmann::basic_json</a></div><div class="ttdoc">a class to store JSON values </div><div class="ttdef"><b>Definition:</b> json.hpp:113</div></div>
<div class="ttc" id="classnlohmann_1_1basic__json_1_1iterator_html"><div class="ttname"><a href="classnlohmann_1_1basic__json_1_1iterator.html">nlohmann::basic_json::iterator</a></div><div class="ttdoc">a random access iterator for the basic_json class </div><div class="ttdef"><b>Definition:</b> json.hpp:3139</div></div>
<div class="ttc" id="namespacenlohmann_html"><div class="ttname"><a href="namespacenlohmann.html">nlohmann</a></div><div class="ttdoc">namespace for Niels Lohmann </div><div class="ttdef"><b>Definition:</b> json.hpp:49</div></div>
<div class="ttc" id="classnlohmann_1_1basic__json_af4261341695729a8e657b94772f95516_html_af4261341695729a8e657b94772f95516"><div class="ttname"><a href="classnlohmann_1_1basic__json_af4261341695729a8e657b94772f95516.html#af4261341695729a8e657b94772f95516">nlohmann::basic_json::begin</a></div><div class="ttdeci">iterator begin() noexcept</div><div class="ttdoc">returns an iterator to the first element </div><div class="ttdef"><b>Definition:</b> json.hpp:2015</div></div>
<div class="ttc" id="classnlohmann_1_1basic__json_a53590b99e380c464a83a0a5edf6da9ab_html_a53590b99e380c464a83a0a5edf6da9ab"><div class="ttname"><a href="classnlohmann_1_1basic__json_a53590b99e380c464a83a0a5edf6da9ab.html#a53590b99e380c464a83a0a5edf6da9ab">nlohmann::basic_json::array</a></div><div class="ttdeci">static basic_json array(list_init_t init=list_init_t())</div><div class="ttdoc">explicitly create an array from an initializer list </div><div class="ttdef"><b>Definition:</b> json.hpp:815</div></div>
</div><!-- fragment --> Output: <pre class="fragment">1
</pre> The example code above can be translated with<pre class="fragment">g++ -std=c++11 -Isrc doc/examples/begin.cpp -o begin </pre>. </dd></dl>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="namespacenlohmann.html">nlohmann</a></li><li class="navelem"><a class="el" href="classnlohmann_1_1basic__json.html">basic_json</a></li>
Update
2015-06-21 22:49:47 +03:00
<li class="footer">Generated on Sun Jun 21 2015 21:49:32 for JSON for Modern C++ by
Update
2015-06-21 22:43:30 +03:00
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.9.1 </li>
</ul>
</div>
</body>
</html>
Reference in New Issue Copy Permalink