<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.15"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Orcus: orcus::json::document_tree 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">Orcus
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.15 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</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"><b>orcus</b></li><li class="navelem"><b>json</b></li><li class="navelem"><a class="el" href="classorcus_1_1json_1_1document__tree.html">document_tree</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#friends">Friends</a> |
<a href="classorcus_1_1json_1_1document__tree-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">orcus::json::document_tree Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include <<a class="el" href="json__document__tree_8hpp_source.html">json_document_tree.hpp</a>></code></p>
<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:a586c2804ce2fb82e23a1b3b51ad4a12c"><td class="memItemLeft" align="right" valign="top"><a id="a586c2804ce2fb82e23a1b3b51ad4a12c"></a>
 </td><td class="memItemRight" valign="bottom"><b>document_tree</b> (const <a class="el" href="classorcus_1_1json_1_1document__tree.html">document_tree</a> &)=delete</td></tr>
<tr class="separator:a586c2804ce2fb82e23a1b3b51ad4a12c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a071247b9a3a39477e1246b8286623f08"><td class="memItemLeft" align="right" valign="top"><a id="a071247b9a3a39477e1246b8286623f08"></a>
 </td><td class="memItemRight" valign="bottom"><b>document_tree</b> (<a class="el" href="classorcus_1_1json_1_1document__tree.html">document_tree</a> &&other)</td></tr>
<tr class="separator:a071247b9a3a39477e1246b8286623f08"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afee269525c439a8d281d9a6375c8a006"><td class="memItemLeft" align="right" valign="top"><a id="afee269525c439a8d281d9a6375c8a006"></a>
 </td><td class="memItemRight" valign="bottom"><b>document_tree</b> (<a class="el" href="classorcus_1_1string__pool.html">string_pool</a> &pool)</td></tr>
<tr class="separator:afee269525c439a8d281d9a6375c8a006"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a920dcd0277609ac76af14a620a3e430e"><td class="memItemLeft" align="right" valign="top"><a id="a920dcd0277609ac76af14a620a3e430e"></a>
 </td><td class="memItemRight" valign="bottom"><b>document_tree</b> (std::initializer_list< <a class="el" href="classorcus_1_1json_1_1detail_1_1init_1_1node.html">detail::init::node</a> > vs)</td></tr>
<tr class="separator:a920dcd0277609ac76af14a620a3e430e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af919f1e0fcbf6881634cadda6bb766b3"><td class="memItemLeft" align="right" valign="top"><a id="af919f1e0fcbf6881634cadda6bb766b3"></a>
 </td><td class="memItemRight" valign="bottom"><b>document_tree</b> (<a class="el" href="classorcus_1_1json_1_1array.html">array</a> vs)</td></tr>
<tr class="separator:af919f1e0fcbf6881634cadda6bb766b3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae023bee2767ddd657e671b7a2e45bac7"><td class="memItemLeft" align="right" valign="top"><a id="ae023bee2767ddd657e671b7a2e45bac7"></a>
 </td><td class="memItemRight" valign="bottom"><b>document_tree</b> (<a class="el" href="classorcus_1_1json_1_1object.html">object</a> obj)</td></tr>
<tr class="separator:ae023bee2767ddd657e671b7a2e45bac7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ada7d1f5234d076a77e8b19799dace451"><td class="memItemLeft" align="right" valign="top"><a id="ada7d1f5234d076a77e8b19799dace451"></a>
<a class="el" href="classorcus_1_1json_1_1document__tree.html">document_tree</a> & </td><td class="memItemRight" valign="bottom"><b>operator=</b> (std::initializer_list< <a class="el" href="classorcus_1_1json_1_1detail_1_1init_1_1node.html">detail::init::node</a> > vs)</td></tr>
<tr class="separator:ada7d1f5234d076a77e8b19799dace451"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a780c08f85d953111649d90cc88500395"><td class="memItemLeft" align="right" valign="top"><a id="a780c08f85d953111649d90cc88500395"></a>
<a class="el" href="classorcus_1_1json_1_1document__tree.html">document_tree</a> & </td><td class="memItemRight" valign="bottom"><b>operator=</b> (<a class="el" href="classorcus_1_1json_1_1array.html">array</a> vs)</td></tr>
<tr class="separator:a780c08f85d953111649d90cc88500395"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9007a64faa80fd6fae6efd46d1eb1a0a"><td class="memItemLeft" align="right" valign="top"><a id="a9007a64faa80fd6fae6efd46d1eb1a0a"></a>
<a class="el" href="classorcus_1_1json_1_1document__tree.html">document_tree</a> & </td><td class="memItemRight" valign="bottom"><b>operator=</b> (<a class="el" href="classorcus_1_1json_1_1object.html">object</a> obj)</td></tr>
<tr class="separator:a9007a64faa80fd6fae6efd46d1eb1a0a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9676663098bbddd361790b22860353f9"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classorcus_1_1json_1_1document__tree.html#a9676663098bbddd361790b22860353f9">load</a> (const std::string &strm, const <a class="el" href="structorcus_1_1json__config.html">json_config</a> &<a class="el" href="structorcus_1_1config.html">config</a>)</td></tr>
<tr class="separator:a9676663098bbddd361790b22860353f9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a826e3e9b19db954d19358f01b1ac6e78"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classorcus_1_1json_1_1document__tree.html#a826e3e9b19db954d19358f01b1ac6e78">load</a> (const char *p, size_t n, const <a class="el" href="structorcus_1_1json__config.html">json_config</a> &<a class="el" href="structorcus_1_1config.html">config</a>)</td></tr>
<tr class="separator:a826e3e9b19db954d19358f01b1ac6e78"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:adc7f3771f5f5b1e42dbfdd9d0630bb8e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classorcus_1_1json_1_1const__node.html">json::const_node</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classorcus_1_1json_1_1document__tree.html#adc7f3771f5f5b1e42dbfdd9d0630bb8e">get_document_root</a> () const</td></tr>
<tr class="separator:adc7f3771f5f5b1e42dbfdd9d0630bb8e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1512977d665bc210e4c6e1dcfbc9352a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classorcus_1_1json_1_1node.html">json::node</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classorcus_1_1json_1_1document__tree.html#a1512977d665bc210e4c6e1dcfbc9352a">get_document_root</a> ()</td></tr>
<tr class="separator:a1512977d665bc210e4c6e1dcfbc9352a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1baf53dd1940986a07f7d51cefabd0c0"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classorcus_1_1json_1_1document__tree.html#a1baf53dd1940986a07f7d51cefabd0c0">dump</a> () const</td></tr>
<tr class="separator:a1baf53dd1940986a07f7d51cefabd0c0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afed31b5374f3c695ed2ea9174b9d6fa2"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classorcus_1_1json_1_1document__tree.html#afed31b5374f3c695ed2ea9174b9d6fa2">dump_xml</a> () const</td></tr>
<tr class="separator:afed31b5374f3c695ed2ea9174b9d6fa2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:acedf88d401bd11c53bb05c10c211eefd"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classorcus_1_1json_1_1document__tree.html#acedf88d401bd11c53bb05c10c211eefd">swap</a> (<a class="el" href="classorcus_1_1json_1_1document__tree.html">document_tree</a> &other)</td></tr>
<tr class="separator:acedf88d401bd11c53bb05c10c211eefd"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
Friends</h2></td></tr>
<tr class="memitem:a220f2e00de7b237254f2e2ba9dc0b635"><td class="memItemLeft" align="right" valign="top"><a id="a220f2e00de7b237254f2e2ba9dc0b635"></a>
class </td><td class="memItemRight" valign="bottom"><b>const_node</b></td></tr>
<tr class="separator:a220f2e00de7b237254f2e2ba9dc0b635"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3700a7180235e9a28534b15d5922de12"><td class="memItemLeft" align="right" valign="top"><a id="a3700a7180235e9a28534b15d5922de12"></a>
class </td><td class="memItemRight" valign="bottom"><b>node</b></td></tr>
<tr class="separator:a3700a7180235e9a28534b15d5922de12"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>This class stores a parsed JSON document tree structure. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a1baf53dd1940986a07f7d51cefabd0c0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1baf53dd1940986a07f7d51cefabd0c0">◆ </a></span>dump()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string orcus::json::document_tree::dump </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Dump the JSON document tree to string.</p>
<dl class="section return"><dt>Returns</dt><dd>a string representation of the JSON document tree. </dd></dl>
</div>
</div>
<a id="afed31b5374f3c695ed2ea9174b9d6fa2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afed31b5374f3c695ed2ea9174b9d6fa2">◆ </a></span>dump_xml()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string orcus::json::document_tree::dump_xml </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Dump the JSON document tree to an XML structure.</p>
<dl class="section return"><dt>Returns</dt><dd>a string containing an XML structure representing the JSON content. </dd></dl>
</div>
</div>
<a id="adc7f3771f5f5b1e42dbfdd9d0630bb8e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adc7f3771f5f5b1e42dbfdd9d0630bb8e">◆ </a></span>get_document_root() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classorcus_1_1json_1_1const__node.html">json::const_node</a> orcus::json::document_tree::get_document_root </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the root node of the document.</p>
<dl class="section return"><dt>Returns</dt><dd>root node of the document. </dd></dl>
</div>
</div>
<a id="a1512977d665bc210e4c6e1dcfbc9352a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1512977d665bc210e4c6e1dcfbc9352a">◆ </a></span>get_document_root() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classorcus_1_1json_1_1node.html">json::node</a> orcus::json::document_tree::get_document_root </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the root node of the document.</p>
<dl class="section return"><dt>Returns</dt><dd>root node of the document. </dd></dl>
</div>
</div>
<a id="a9676663098bbddd361790b22860353f9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9676663098bbddd361790b22860353f9">◆ </a></span>load() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void orcus::json::document_tree::load </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>strm</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="structorcus_1_1json__config.html">json_config</a> & </td>
<td class="paramname"><em>config</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Load raw string stream containing a JSON structure to populate the document tree.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">strm</td><td>stream containing a JSON structure. </td></tr>
<tr><td class="paramname">config</td><td>configuration object. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a826e3e9b19db954d19358f01b1ac6e78"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a826e3e9b19db954d19358f01b1ac6e78">◆ </a></span>load() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void orcus::json::document_tree::load </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>p</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>n</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="structorcus_1_1json__config.html">json_config</a> & </td>
<td class="paramname"><em>config</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Load raw string stream containing a JSON structure to populate the document tree.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">p</td><td>pointer to the stream containing a JSON structure. </td></tr>
<tr><td class="paramname">n</td><td>size of the stream. </td></tr>
<tr><td class="paramname">config</td><td>configuration object. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="acedf88d401bd11c53bb05c10c211eefd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acedf88d401bd11c53bb05c10c211eefd">◆ </a></span>swap()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void orcus::json::document_tree::swap </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classorcus_1_1json_1_1document__tree.html">document_tree</a> & </td>
<td class="paramname"><em>other</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Swap the content of the document with another document instance.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">other</td><td>document instance to swap the content with. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Jan 11 2019 05:05:19 for Orcus by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.15
</small></address>
</body>
</html>
