<!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_config Struct 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"><a class="el" href="structorcus_1_1json__config.html">json_config</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> |
<a href="#pub-attribs">Public Attributes</a> |
<a href="structorcus_1_1json__config-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">orcus::json_config Struct Reference</div> </div>
</div><!--header-->
<div class="contents">
<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:a14880de420f3002382c755c96da98ecd"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="structorcus_1_1json__config.html#a14880de420f3002382c755c96da98ecd">output_format_type</a> { <a class="el" href="structorcus_1_1json__config.html#a14880de420f3002382c755c96da98ecda334c4a4c42fdb79d7ebc3e73b517e6f8">output_format_type::none</a>,
<a class="el" href="structorcus_1_1json__config.html#a14880de420f3002382c755c96da98ecda0f635d0e0f3874fff8b581c132e6c7a7">output_format_type::xml</a>,
<a class="el" href="structorcus_1_1json__config.html#a14880de420f3002382c755c96da98ecda466deec76ecdf5fca6d38571f6324d54">output_format_type::json</a>,
<a class="el" href="structorcus_1_1json__config.html#a14880de420f3002382c755c96da98ecda0ba4439ee9a46d9d9f14c60f88f45f87">output_format_type::check</a>
}</td></tr>
<tr class="separator:a14880de420f3002382c755c96da98ecd"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:af408ab3f3ae3860638102c9eef6c40bf"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="structorcus_1_1json__config.html#af408ab3f3ae3860638102c9eef6c40bf">input_path</a></td></tr>
<tr class="separator:af408ab3f3ae3860638102c9eef6c40bf"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1e4a9789711fa8ce0f6620c7d0c77211"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="structorcus_1_1json__config.html#a1e4a9789711fa8ce0f6620c7d0c77211">output_path</a></td></tr>
<tr class="separator:a1e4a9789711fa8ce0f6620c7d0c77211"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7615265d0b2d243d6e9d5bacf977a597"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structorcus_1_1json__config.html#a14880de420f3002382c755c96da98ecd">output_format_type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structorcus_1_1json__config.html#a7615265d0b2d243d6e9d5bacf977a597">output_format</a></td></tr>
<tr class="separator:a7615265d0b2d243d6e9d5bacf977a597"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac578373d1f5c1435000bcbd30edede2c"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="structorcus_1_1json__config.html#ac578373d1f5c1435000bcbd30edede2c">preserve_object_order</a></td></tr>
<tr class="separator:ac578373d1f5c1435000bcbd30edede2c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7bbf5f7469d5baf215d2398ebb4fc5b2"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="structorcus_1_1json__config.html#a7bbf5f7469d5baf215d2398ebb4fc5b2">resolve_references</a></td></tr>
<tr class="separator:a7bbf5f7469d5baf215d2398ebb4fc5b2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2e86a01a89d931d3c495a18770b0d28a"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="structorcus_1_1json__config.html#a2e86a01a89d931d3c495a18770b0d28a">persistent_string_values</a></td></tr>
<tr class="separator:a2e86a01a89d931d3c495a18770b0d28a"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<h2 class="groupheader">Member Enumeration Documentation</h2>
<a id="a14880de420f3002382c755c96da98ecd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a14880de420f3002382c755c96da98ecd">◆ </a></span>output_format_type</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="structorcus_1_1json__config.html#a14880de420f3002382c755c96da98ecd">orcus::json_config::output_format_type</a></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">strong</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a14880de420f3002382c755c96da98ecda334c4a4c42fdb79d7ebc3e73b517e6f8"></a>none </td><td class="fielddoc"><p>Output format is not specified. </p>
</td></tr>
<tr><td class="fieldname"><a id="a14880de420f3002382c755c96da98ecda0f635d0e0f3874fff8b581c132e6c7a7"></a>xml </td><td class="fielddoc"><p>Output format is XML. </p>
</td></tr>
<tr><td class="fieldname"><a id="a14880de420f3002382c755c96da98ecda466deec76ecdf5fca6d38571f6324d54"></a>json </td><td class="fielddoc"><p>Output format is JSON. </p>
</td></tr>
<tr><td class="fieldname"><a id="a14880de420f3002382c755c96da98ecda0ba4439ee9a46d9d9f14c60f88f45f87"></a>check </td><td class="fielddoc"><p>Special output format used in unit tests to verify content. </p>
</td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="af408ab3f3ae3860638102c9eef6c40bf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af408ab3f3ae3860638102c9eef6c40bf">◆ </a></span>input_path</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string orcus::json_config::input_path</td>
</tr>
</table>
</div><div class="memdoc">
<p>Path of the JSON file being parsed, in case the JSON string originates from a file. This parameter is required if external JSON files need to be resolved. Otherwise it's optional. </p>
</div>
</div>
<a id="a7615265d0b2d243d6e9d5bacf977a597"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7615265d0b2d243d6e9d5bacf977a597">◆ </a></span>output_format</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structorcus_1_1json__config.html#a14880de420f3002382c755c96da98ecd">output_format_type</a> orcus::json_config::output_format</td>
</tr>
</table>
</div><div class="memdoc">
<p>Output format type. Used only from the orcus-json command line tool. </p>
</div>
</div>
<a id="a1e4a9789711fa8ce0f6620c7d0c77211"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1e4a9789711fa8ce0f6620c7d0c77211">◆ </a></span>output_path</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string orcus::json_config::output_path</td>
</tr>
</table>
</div><div class="memdoc">
<p>Path of the file to which output is written to. Used only from the orcus-json command line tool. </p>
</div>
</div>
<a id="a2e86a01a89d931d3c495a18770b0d28a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2e86a01a89d931d3c495a18770b0d28a">◆ </a></span>persistent_string_values</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool orcus::json_config::persistent_string_values</td>
</tr>
</table>
</div><div class="memdoc">
<p>When true, the document tree should allocate memory and hold copies of string values in the tree. When false, no extra memory is allocated for string values in the tree and the string values simply point to the original json string stream.</p>
<p>In other words, when this option is set to false, the caller must ensure that the json string stream instance stays alive for the entire life cycle of the document tree. </p>
</div>
</div>
<a id="ac578373d1f5c1435000bcbd30edede2c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac578373d1f5c1435000bcbd30edede2c">◆ </a></span>preserve_object_order</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool orcus::json_config::preserve_object_order</td>
</tr>
</table>
</div><div class="memdoc">
<p>Control whether or not to preserve the order of object's child name/value pairs. By definition, JSON's object is an unordered set of name/value pairs, but in some cases preserving the original order may be desirable. </p>
</div>
</div>
<a id="a7bbf5f7469d5baf215d2398ebb4fc5b2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7bbf5f7469d5baf215d2398ebb4fc5b2">◆ </a></span>resolve_references</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool orcus::json_config::resolve_references</td>
</tr>
</table>
</div><div class="memdoc">
<p>Control whether or not to resolve JSON references to external files. </p>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Jan 11 2019 05:05:18 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>
