blob: 9269b5246e8eb25065f0f569ca0c48bcc0e672c7 [file] [log] [blame]
<!-- HTML header for doxygen 1.8.7-->
<!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.16"/>
<title>RapidJSON: rapidjson::GenericSchemaDocument&lt; ValueT, Allocator &gt; Class Template 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="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">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(initResizable);
/* @license-end */</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">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function() { init_search(); });
/* @license-end */
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="doxygenextra.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="topbanner"><a href="https://github.com/Tencent/rapidjson" title="RapidJSON GitHub"><i class="githublogo"></i></a></div>
<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>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.16 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
</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">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('classrapidjson_1_1_generic_schema_document.html','');});
/* @license-end */
</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="header">
<div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#friends">Friends</a> &#124;
<a href="classrapidjson_1_1_generic_schema_document-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">rapidjson::GenericSchemaDocument&lt; ValueT, Allocator &gt; Class Template Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>JSON schema document.
<a href="classrapidjson_1_1_generic_schema_document.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="schema_8h_source.html">schema.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:a87eb1db271e7f57442802a5f4f6178f3"><td class="memItemLeft" align="right" valign="top"><a id="a87eb1db271e7f57442802a5f4f6178f3"></a>
typedef ValueT&#160;</td><td class="memItemRight" valign="bottom"><b>ValueType</b></td></tr>
<tr class="separator:a87eb1db271e7f57442802a5f4f6178f3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab2764f2258889b3262eff6293d7ca015"><td class="memItemLeft" align="right" valign="top"><a id="ab2764f2258889b3262eff6293d7ca015"></a>
typedef <a class="el" href="classrapidjson_1_1_i_generic_remote_schema_document_provider.html">IGenericRemoteSchemaDocumentProvider</a>&lt; <a class="el" href="classrapidjson_1_1_generic_schema_document.html">GenericSchemaDocument</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>IRemoteSchemaDocumentProviderType</b></td></tr>
<tr class="separator:ab2764f2258889b3262eff6293d7ca015"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6fc497ef6e303b3a3ecec9fefe82eade"><td class="memItemLeft" align="right" valign="top"><a id="a6fc497ef6e303b3a3ecec9fefe82eade"></a>
typedef <a class="el" href="classrapidjson_1_1_allocator.html">Allocator</a>&#160;</td><td class="memItemRight" valign="bottom"><b>AllocatorType</b></td></tr>
<tr class="separator:a6fc497ef6e303b3a3ecec9fefe82eade"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a019035fd281ca52874ed434ce4f7d4d8"><td class="memItemLeft" align="right" valign="top"><a id="a019035fd281ca52874ed434ce4f7d4d8"></a>
typedef ValueType::EncodingType&#160;</td><td class="memItemRight" valign="bottom"><b>EncodingType</b></td></tr>
<tr class="separator:a019035fd281ca52874ed434ce4f7d4d8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af9b82162834b30bdcbe93cb065d0aedd"><td class="memItemLeft" align="right" valign="top"><a id="af9b82162834b30bdcbe93cb065d0aedd"></a>
typedef EncodingType::Ch&#160;</td><td class="memItemRight" valign="bottom"><b>Ch</b></td></tr>
<tr class="separator:af9b82162834b30bdcbe93cb065d0aedd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaf4e7f371de938025f7ed4be3b83266e"><td class="memItemLeft" align="right" valign="top"><a id="aaf4e7f371de938025f7ed4be3b83266e"></a>
typedef internal::Schema&lt; <a class="el" href="classrapidjson_1_1_generic_schema_document.html">GenericSchemaDocument</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>SchemaType</b></td></tr>
<tr class="separator:aaf4e7f371de938025f7ed4be3b83266e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a61540c0f8aa542760ae03257a0e6dab7"><td class="memItemLeft" align="right" valign="top"><a id="a61540c0f8aa542760ae03257a0e6dab7"></a>
typedef <a class="el" href="classrapidjson_1_1_generic_pointer.html">GenericPointer</a>&lt; ValueType, <a class="el" href="classrapidjson_1_1_allocator.html">Allocator</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>PointerType</b></td></tr>
<tr class="separator:a61540c0f8aa542760ae03257a0e6dab7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a72e8240701d707953bfd806cddc995b6"><td class="memItemLeft" align="right" valign="top"><a id="a72e8240701d707953bfd806cddc995b6"></a>
typedef <a class="el" href="classrapidjson_1_1_generic_value.html">GenericValue</a>&lt; EncodingType, <a class="el" href="classrapidjson_1_1_allocator.html">Allocator</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>URIType</b></td></tr>
<tr class="separator:a72e8240701d707953bfd806cddc995b6"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><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:aeebf51ef6353f6a01d6f6618da6d0865"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classrapidjson_1_1_generic_schema_document.html#aeebf51ef6353f6a01d6f6618da6d0865">GenericSchemaDocument</a> (const ValueType &amp;document, const Ch *uri=0, <a class="el" href="namespacerapidjson.html#a44eb33eaa523e36d466b1ced64b85c84">SizeType</a> uriLength=0, <a class="el" href="classrapidjson_1_1_i_generic_remote_schema_document_provider.html">IRemoteSchemaDocumentProviderType</a> *remoteProvider=0, <a class="el" href="classrapidjson_1_1_allocator.html">Allocator</a> *allocator=0)</td></tr>
<tr class="memdesc:aeebf51ef6353f6a01d6f6618da6d0865"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor. <a href="classrapidjson_1_1_generic_schema_document.html#aeebf51ef6353f6a01d6f6618da6d0865">More...</a><br /></td></tr>
<tr class="separator:aeebf51ef6353f6a01d6f6618da6d0865"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adf6f3372013227873ed392dee1e752bf"><td class="memItemLeft" align="right" valign="top"><a id="adf6f3372013227873ed392dee1e752bf"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classrapidjson_1_1_generic_schema_document.html#adf6f3372013227873ed392dee1e752bf">~GenericSchemaDocument</a> ()</td></tr>
<tr class="memdesc:adf6f3372013227873ed392dee1e752bf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor. <br /></td></tr>
<tr class="separator:adf6f3372013227873ed392dee1e752bf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a55b013a5f3f213d198ac0205ba6ea9b0"><td class="memItemLeft" align="right" valign="top"><a id="a55b013a5f3f213d198ac0205ba6ea9b0"></a>
const <a class="el" href="classrapidjson_1_1_generic_value.html">URIType</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>GetURI</b> () const</td></tr>
<tr class="separator:a55b013a5f3f213d198ac0205ba6ea9b0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8b2ac6de85dc9c1fb4f4d0be4aeb2d6a"><td class="memItemLeft" align="right" valign="top"><a id="a8b2ac6de85dc9c1fb4f4d0be4aeb2d6a"></a>
const SchemaType &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classrapidjson_1_1_generic_schema_document.html#a8b2ac6de85dc9c1fb4f4d0be4aeb2d6a">GetRoot</a> () const</td></tr>
<tr class="memdesc:a8b2ac6de85dc9c1fb4f4d0be4aeb2d6a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the root schema. <br /></td></tr>
<tr class="separator:a8b2ac6de85dc9c1fb4f4d0be4aeb2d6a"><td class="memSeparator" colspan="2">&#160;</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:afcc03e6ba8f1a819e1a028c31ad38347"><td class="memTemplParams" colspan="2"><a id="afcc03e6ba8f1a819e1a028c31ad38347"></a>
template&lt;typename , typename , typename &gt; </td></tr>
<tr class="memitem:afcc03e6ba8f1a819e1a028c31ad38347"><td class="memTemplItemLeft" align="right" valign="top">class&#160;</td><td class="memTemplItemRight" valign="bottom"><b>GenericSchemaValidator</b></td></tr>
<tr class="separator:afcc03e6ba8f1a819e1a028c31ad38347"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><h3>template&lt;typename ValueT, typename Allocator = CrtAllocator&gt;<br />
class rapidjson::GenericSchemaDocument&lt; ValueT, Allocator &gt;</h3>
<p>JSON schema document. </p>
<p>A JSON schema document is a compiled version of a JSON schema. It is basically a tree of internal::Schema.</p>
<dl class="section note"><dt>Note</dt><dd>This is an immutable class (i.e. its instance cannot be modified after construction). </dd></dl>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">ValueT</td><td>Type of JSON value (e.g. <code>Value</code> ), which also determine the encoding. </td></tr>
<tr><td class="paramname"><a class="el" href="classrapidjson_1_1_allocator.html" title="Concept for allocating, resizing and freeing memory block.">Allocator</a></td><td><a class="el" href="classrapidjson_1_1_allocator.html" title="Concept for allocating, resizing and freeing memory block.">Allocator</a> type for allocating memory of this document. </td></tr>
</table>
</dd>
</dl>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="aeebf51ef6353f6a01d6f6618da6d0865"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aeebf51ef6353f6a01d6f6618da6d0865">&#9670;&nbsp;</a></span>GenericSchemaDocument()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename ValueT , typename Allocator = CrtAllocator&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classrapidjson_1_1_generic_schema_document.html">rapidjson::GenericSchemaDocument</a>&lt; ValueT, <a class="el" href="classrapidjson_1_1_allocator.html">Allocator</a> &gt;::<a class="el" href="classrapidjson_1_1_generic_schema_document.html">GenericSchemaDocument</a> </td>
<td>(</td>
<td class="paramtype">const ValueType &amp;&#160;</td>
<td class="paramname"><em>document</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const Ch *&#160;</td>
<td class="paramname"><em>uri</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespacerapidjson.html#a44eb33eaa523e36d466b1ced64b85c84">SizeType</a>&#160;</td>
<td class="paramname"><em>uriLength</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classrapidjson_1_1_i_generic_remote_schema_document_provider.html">IRemoteSchemaDocumentProviderType</a> *&#160;</td>
<td class="paramname"><em>remoteProvider</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classrapidjson_1_1_allocator.html">Allocator</a> *&#160;</td>
<td class="paramname"><em>allocator</em> = <code>0</code>&#160;</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 class="mlabel">explicit</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructor. </p>
<p>Compile a JSON document into schema document.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">document</td><td>A JSON document as source. </td></tr>
<tr><td class="paramname">uri</td><td>The base URI of this schema document for purposes of violation reporting. </td></tr>
<tr><td class="paramname">uriLength</td><td>Length of <code>name</code>, in code points. </td></tr>
<tr><td class="paramname">remoteProvider</td><td>An optional remote schema document provider for resolving remote reference. Can be null. </td></tr>
<tr><td class="paramname">allocator</td><td>An optional allocator instance for allocating memory. Can be null. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>include/rapidjson/<a class="el" href="fwd_8h_source.html">fwd.h</a></li>
<li>include/rapidjson/<a class="el" href="schema_8h_source.html">schema.h</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- HTML footer for doxygen 1.8.7-->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="namespacerapidjson.html">rapidjson</a></li><li class="navelem"><a class="el" href="classrapidjson_1_1_generic_schema_document.html">GenericSchemaDocument</a></li>
</ul>
</div>
</body>
</html>