<!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>Orcus: orcus::json::const_node 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.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"><b>orcus</b></li><li class="navelem"><b>json</b></li><li class="navelem"><a class="el" href="classorcus_1_1json_1_1const__node.html">const_node</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pro-methods">Protected Member Functions</a> |
<a href="#pro-attribs">Protected Attributes</a> |
<a href="#friends">Friends</a> |
<a href="classorcus_1_1json_1_1const__node-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">orcus::json::const_node 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>
<div class="dynheader">
Inheritance diagram for orcus::json::const_node:</div>
<div class="dyncontent">
<div class="center">
<img src="classorcus_1_1json_1_1const__node.png" usemap="#orcus::json::const_5Fnode_map" alt=""/>
<map id="orcus::json::const_5Fnode_map" name="orcus::json::const_5Fnode_map">
<area href="classorcus_1_1json_1_1node.html" alt="orcus::json::node" shape="rect" coords="0,56,144,80"/>
</map>
</div></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:a0bb0e824f5227b8092058db2069bb85d"><td class="memItemLeft" align="right" valign="top"><a id="a0bb0e824f5227b8092058db2069bb85d"></a>
 </td><td class="memItemRight" valign="bottom"><b>const_node</b> (const <a class="el" href="classorcus_1_1json_1_1const__node.html">const_node</a> &other)</td></tr>
<tr class="separator:a0bb0e824f5227b8092058db2069bb85d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a048b578ce4c066100bffb1fbddb69a49"><td class="memItemLeft" align="right" valign="top"><a id="a048b578ce4c066100bffb1fbddb69a49"></a>
 </td><td class="memItemRight" valign="bottom"><b>const_node</b> (<a class="el" href="classorcus_1_1json_1_1const__node.html">const_node</a> &&rhs)</td></tr>
<tr class="separator:a048b578ce4c066100bffb1fbddb69a49"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a759c01f443f25a202392dbc4885281b9"><td class="memItemLeft" align="right" valign="top">node_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classorcus_1_1json_1_1const__node.html#a759c01f443f25a202392dbc4885281b9">type</a> () const</td></tr>
<tr class="separator:a759c01f443f25a202392dbc4885281b9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a98afb73f0d321f5b5267d2dcb0d6578a"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classorcus_1_1json_1_1const__node.html#a98afb73f0d321f5b5267d2dcb0d6578a">child_count</a> () const</td></tr>
<tr class="separator:a98afb73f0d321f5b5267d2dcb0d6578a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab7d4785a7644c214f3d6a2f0c7b5f983"><td class="memItemLeft" align="right" valign="top">std::vector< <a class="el" href="classorcus_1_1pstring.html">pstring</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classorcus_1_1json_1_1const__node.html#ab7d4785a7644c214f3d6a2f0c7b5f983">keys</a> () const</td></tr>
<tr class="separator:ab7d4785a7644c214f3d6a2f0c7b5f983"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a135dde804951a56c701df18f1350efd0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classorcus_1_1pstring.html">pstring</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classorcus_1_1json_1_1const__node.html#a135dde804951a56c701df18f1350efd0">key</a> (size_t index) const</td></tr>
<tr class="separator:a135dde804951a56c701df18f1350efd0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a54aa6d8d1d9317c02b2909266a59f9c2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classorcus_1_1json_1_1const__node.html">const_node</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classorcus_1_1json_1_1const__node.html#a54aa6d8d1d9317c02b2909266a59f9c2">child</a> (size_t index) const</td></tr>
<tr class="separator:a54aa6d8d1d9317c02b2909266a59f9c2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abb834157882d44e0b9a305f3e717aff0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classorcus_1_1json_1_1const__node.html">const_node</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classorcus_1_1json_1_1const__node.html#abb834157882d44e0b9a305f3e717aff0">child</a> (const <a class="el" href="classorcus_1_1pstring.html">pstring</a> &<a class="el" href="classorcus_1_1json_1_1const__node.html#a135dde804951a56c701df18f1350efd0">key</a>) const</td></tr>
<tr class="separator:abb834157882d44e0b9a305f3e717aff0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab99741b4a0196b6a015119a7726a3e3e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classorcus_1_1json_1_1const__node.html">const_node</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classorcus_1_1json_1_1const__node.html#ab99741b4a0196b6a015119a7726a3e3e">parent</a> () const</td></tr>
<tr class="separator:ab99741b4a0196b6a015119a7726a3e3e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa641afffae54a48b05dbf3ed5f9cf15e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classorcus_1_1pstring.html">pstring</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classorcus_1_1json_1_1const__node.html#aa641afffae54a48b05dbf3ed5f9cf15e">string_value</a> () const</td></tr>
<tr class="separator:aa641afffae54a48b05dbf3ed5f9cf15e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a740e40791d54fbd320081e695eede951"><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="classorcus_1_1json_1_1const__node.html#a740e40791d54fbd320081e695eede951">numeric_value</a> () const</td></tr>
<tr class="separator:a740e40791d54fbd320081e695eede951"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2a2fa71ac12796a6c76caed1ebcf81b6"><td class="memItemLeft" align="right" valign="top"><a id="a2a2fa71ac12796a6c76caed1ebcf81b6"></a>
<a class="el" href="classorcus_1_1json_1_1const__node.html">const_node</a> & </td><td class="memItemRight" valign="bottom"><b>operator=</b> (const <a class="el" href="classorcus_1_1json_1_1const__node.html">const_node</a> &other)</td></tr>
<tr class="separator:a2a2fa71ac12796a6c76caed1ebcf81b6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9e8e39f9f62f95576aa12f5496329a04"><td class="memItemLeft" align="right" valign="top">uintptr_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classorcus_1_1json_1_1const__node.html#a9e8e39f9f62f95576aa12f5496329a04">identity</a> () const</td></tr>
<tr class="separator:a9e8e39f9f62f95576aa12f5496329a04"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:a691810423391dc4bd18d9a59fef48840"><td class="memItemLeft" align="right" valign="top"><a id="a691810423391dc4bd18d9a59fef48840"></a>
 </td><td class="memItemRight" valign="bottom"><b>const_node</b> (const <a class="el" href="classorcus_1_1json_1_1document__tree.html">document_tree</a> *doc, json_value *jv)</td></tr>
<tr class="separator:a691810423391dc4bd18d9a59fef48840"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad7c5deba75bccf204baf827bdb9f56f3"><td class="memItemLeft" align="right" valign="top"><a id="ad7c5deba75bccf204baf827bdb9f56f3"></a>
 </td><td class="memItemRight" valign="bottom"><b>const_node</b> (std::unique_ptr< impl > &&p)</td></tr>
<tr class="separator:ad7c5deba75bccf204baf827bdb9f56f3"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:a549e05ff867538a038323585211dc33f"><td class="memItemLeft" align="right" valign="top"><a id="a549e05ff867538a038323585211dc33f"></a>
std::unique_ptr< impl > </td><td class="memItemRight" valign="bottom"><b>mp_impl</b></td></tr>
<tr class="separator:a549e05ff867538a038323585211dc33f"><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:abcbd49e63f506b84964eaa01e93c9c5d"><td class="memItemLeft" align="right" valign="top"><a id="abcbd49e63f506b84964eaa01e93c9c5d"></a>
class </td><td class="memItemRight" valign="bottom"><b>document_tree</b></td></tr>
<tr class="separator:abcbd49e63f506b84964eaa01e93c9c5d"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Each node instance represents a JSON value stored in the document tree. It's immutable. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a54aa6d8d1d9317c02b2909266a59f9c2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a54aa6d8d1d9317c02b2909266a59f9c2">◆ </a></span>child() <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">const_node</a> orcus::json::const_node::child </td>
<td>(</td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>index</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get a child node by index.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">index</td><td>0-based index of a child node.</td></tr>
</table>
</dd>
</dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="classorcus_1_1json_1_1document__error.html">orcus::json::document_error</a></td><td>if the node is not one of the object or array types.</td></tr>
<tr><td class="paramname">std::out_of_range</td><td>if the index is equal to or greater than the number of child nodes that the node has.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>child node instance. </dd></dl>
</div>
</div>
<a id="abb834157882d44e0b9a305f3e717aff0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abb834157882d44e0b9a305f3e717aff0">◆ </a></span>child() <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_1const__node.html">const_node</a> orcus::json::const_node::child </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classorcus_1_1pstring.html">pstring</a> & </td>
<td class="paramname"><em>key</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get a child node by textural key value.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">key</td><td>textural key value to get a child node by.</td></tr>
</table>
</dd>
</dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="classorcus_1_1json_1_1document__error.html">orcus::json::document_error</a></td><td>if the node is not of the object type, or the node doesn't have the specified key.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>child node instance. </dd></dl>
</div>
</div>
<a id="a98afb73f0d321f5b5267d2dcb0d6578a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a98afb73f0d321f5b5267d2dcb0d6578a">◆ </a></span>child_count()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">size_t orcus::json::const_node::child_count </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the number of child nodes if any.</p>
<dl class="section return"><dt>Returns</dt><dd>number of child nodes. </dd></dl>
</div>
</div>
<a id="a9e8e39f9f62f95576aa12f5496329a04"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9e8e39f9f62f95576aa12f5496329a04">◆ </a></span>identity()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uintptr_t orcus::json::const_node::identity </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Return an indentifier of the JSON value object that the node represents. The identifier is derived directly from the memory address of the value object.</p>
<dl class="section return"><dt>Returns</dt><dd>identifier of the JSON value object. </dd></dl>
</div>
</div>
<a id="a135dde804951a56c701df18f1350efd0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a135dde804951a56c701df18f1350efd0">◆ </a></span>key()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classorcus_1_1pstring.html">pstring</a> orcus::json::const_node::key </td>
<td>(</td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>index</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the key by index in a JSON object node. This method works only when the <b>preserve object order</b> option is set.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">index</td><td>0-based key index.</td></tr>
</table>
</dd>
</dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="classorcus_1_1json_1_1document__error.html">orcus::json::document_error</a></td><td>if the node is not of the object type.</td></tr>
<tr><td class="paramname">std::out_of_range</td><td>if the index is equal to or greater than the number of keys stored in the node.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>key value. </dd></dl>
</div>
</div>
<a id="ab7d4785a7644c214f3d6a2f0c7b5f983"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab7d4785a7644c214f3d6a2f0c7b5f983">◆ </a></span>keys()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::vector<<a class="el" href="classorcus_1_1pstring.html">pstring</a>> orcus::json::const_node::keys </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get a list of keys stored in a JSON object node.</p>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="classorcus_1_1json_1_1document__error.html">orcus::json::document_error</a></td><td>if the node is not of the object type. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a list of keys. </dd></dl>
</div>
</div>
<a id="a740e40791d54fbd320081e695eede951"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a740e40791d54fbd320081e695eede951">◆ </a></span>numeric_value()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double orcus::json::const_node::numeric_value </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the numeric value of a JSON number node.</p>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="classorcus_1_1json_1_1document__error.html">orcus::json::document_error</a></td><td>if the node is not of the number type.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>numeric value. </dd></dl>
</div>
</div>
<a id="ab99741b4a0196b6a015119a7726a3e3e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab99741b4a0196b6a015119a7726a3e3e">◆ </a></span>parent()</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">const_node</a> orcus::json::const_node::parent </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the parent node.</p>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="classorcus_1_1json_1_1document__error.html">orcus::json::document_error</a></td><td>if the node doesn't have a parent node which implies that the node is a root node.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>parent node instance. </dd></dl>
</div>
</div>
<a id="aa641afffae54a48b05dbf3ed5f9cf15e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa641afffae54a48b05dbf3ed5f9cf15e">◆ </a></span>string_value()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classorcus_1_1pstring.html">pstring</a> orcus::json::const_node::string_value </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the string value of a JSON string node.</p>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="classorcus_1_1json_1_1document__error.html">orcus::json::document_error</a></td><td>if the node is not of the string type.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>string value. </dd></dl>
</div>
</div>
<a id="a759c01f443f25a202392dbc4885281b9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a759c01f443f25a202392dbc4885281b9">◆ </a></span>type()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">node_t orcus::json::const_node::type </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the type of a node.</p>
<dl class="section return"><dt>Returns</dt><dd>node type. </dd></dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sat Feb 9 2019 16:54:03 for Orcus 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>
