generic-library/cereal
1
0
Fork 0
mirror of https://github.com/USCiLab/cereal.git synced 2025-07-21 02:22:01 +02:00
Code Issues Projects Releases Wiki Activity
cereal/assets/doxygen/classcereal_1_1XMLOutputArchive_1_1Options.html
Shane Grant bf9fc8231e Update doc for 132
2022-02-27 19:48:38 -08:00

214 lines
15 KiB
HTML
Raw Permalink Blame History

<!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.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>cereal: cereal::XMLOutputArchive::Options 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">cereal
</div>
<div id="projectbrief">A C++11 library for serialization</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<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>
<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&amp;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>cereal</b></li><li class="navelem"><a class="el" href="classcereal_1_1XMLOutputArchive.html">XMLOutputArchive</a></li><li class="navelem"><a class="el" href="classcereal_1_1XMLOutputArchive_1_1Options.html">Options</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="#friends">Friends</a> &#124;
<a href="classcereal_1_1XMLOutputArchive_1_1Options-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">cereal::XMLOutputArchive::Options Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>A class containing various advanced options for the XML archive.
<a href="classcereal_1_1XMLOutputArchive_1_1Options.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="xml_8hpp_source.html">/home/shane/workspace/cereal/include/cereal/archives/xml.hpp</a>&gt;</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:ad0720fae6be971e51ca8230b3868b894"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcereal_1_1XMLOutputArchive_1_1Options.html#ad0720fae6be971e51ca8230b3868b894">Options</a> (int precision_=std::numeric_limits&lt; double &gt;::max_digits10, bool indent_=true, bool outputType_=false, bool sizeAttributes_=true)</td></tr>
<tr class="memdesc:ad0720fae6be971e51ca8230b3868b894"><td class="mdescLeft">&#160;</td><td class="mdescRight">Specify specific options for the <a class="el" href="classcereal_1_1XMLOutputArchive.html" title="An output archive designed to save data to XML.">XMLOutputArchive</a>. <a href="classcereal_1_1XMLOutputArchive_1_1Options.html#ad0720fae6be971e51ca8230b3868b894">More...</a><br /></td></tr>
<tr class="separator:ad0720fae6be971e51ca8230b3868b894"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr><td colspan="2"><div class="groupHeader">Option Modifiers</div></td></tr>
<tr><td colspan="2"><div class="groupText"><p>An interface for setting option settings analogous to named parameters.</p>
<div class="fragment"><div class="line"><a class="code" href="classcereal_1_1XMLOutputArchive.html">cereal::XMLOutputArchive</a> ar( myStream,</div>
<div class="line"> <a class="code" href="classcereal_1_1XMLOutputArchive_1_1Options.html">cereal::XMLOutputArchive::Options</a>()</div>
<div class="line"> .<a class="code" href="classcereal_1_1XMLOutputArchive_1_1Options.html#a926a95d1282e4e34707b989f911158ff">indent</a>(<span class="keyword">true</span>)</div>
<div class="line"> .<a class="code" href="classcereal_1_1XMLOutputArchive_1_1Options.html#a46c5745849c2a6dafb24c1010a984f03">sizeAttributes</a>(<span class="keyword">false</span>) );</div>
</div><!-- fragment --> </div></td></tr>
<tr class="memitem:a383c18094a344177bc70f2c335854c2d"><td class="memItemLeft" align="right" valign="top"><a id="a383c18094a344177bc70f2c335854c2d"></a>
<a class="el" href="classcereal_1_1XMLOutputArchive_1_1Options.html">Options</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcereal_1_1XMLOutputArchive_1_1Options.html#a383c18094a344177bc70f2c335854c2d">precision</a> (int value)</td></tr>
<tr class="memdesc:a383c18094a344177bc70f2c335854c2d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the precision used for floaing point numbers. <br /></td></tr>
<tr class="separator:a383c18094a344177bc70f2c335854c2d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a926a95d1282e4e34707b989f911158ff"><td class="memItemLeft" align="right" valign="top"><a id="a926a95d1282e4e34707b989f911158ff"></a>
<a class="el" href="classcereal_1_1XMLOutputArchive_1_1Options.html">Options</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcereal_1_1XMLOutputArchive_1_1Options.html#a926a95d1282e4e34707b989f911158ff">indent</a> (bool enable)</td></tr>
<tr class="memdesc:a926a95d1282e4e34707b989f911158ff"><td class="mdescLeft">&#160;</td><td class="mdescRight">Whether to indent each line of XML. <br /></td></tr>
<tr class="separator:a926a95d1282e4e34707b989f911158ff"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6b0b31ffd692edb1df6b312704241cf1"><td class="memItemLeft" align="right" valign="top"><a id="a6b0b31ffd692edb1df6b312704241cf1"></a>
<a class="el" href="classcereal_1_1XMLOutputArchive_1_1Options.html">Options</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcereal_1_1XMLOutputArchive_1_1Options.html#a6b0b31ffd692edb1df6b312704241cf1">outputType</a> (bool enable)</td></tr>
<tr class="memdesc:a6b0b31ffd692edb1df6b312704241cf1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Whether to output the type of each serialized object as an attribute. <br /></td></tr>
<tr class="separator:a6b0b31ffd692edb1df6b312704241cf1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a46c5745849c2a6dafb24c1010a984f03"><td class="memItemLeft" align="right" valign="top"><a id="a46c5745849c2a6dafb24c1010a984f03"></a>
<a class="el" href="classcereal_1_1XMLOutputArchive_1_1Options.html">Options</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcereal_1_1XMLOutputArchive_1_1Options.html#a46c5745849c2a6dafb24c1010a984f03">sizeAttributes</a> (bool enable)</td></tr>
<tr class="memdesc:a46c5745849c2a6dafb24c1010a984f03"><td class="mdescLeft">&#160;</td><td class="mdescRight">Whether dynamically sized containers (e.g. vector) output the size=dynamic attribute. <br /></td></tr>
<tr class="separator:a46c5745849c2a6dafb24c1010a984f03"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:ab7120fd4a284844186093c581e922c87"><td class="memItemLeft" align="right" valign="top"><a id="ab7120fd4a284844186093c581e922c87"></a>
static <a class="el" href="classcereal_1_1XMLOutputArchive_1_1Options.html">Options</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcereal_1_1XMLOutputArchive_1_1Options.html#ab7120fd4a284844186093c581e922c87">Default</a> ()</td></tr>
<tr class="memdesc:ab7120fd4a284844186093c581e922c87"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default options. <br /></td></tr>
<tr class="separator:ab7120fd4a284844186093c581e922c87"><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:a7fe2c3c8bfbca5f779dd329d1d80ddac"><td class="memItemLeft" align="right" valign="top"><a id="a7fe2c3c8bfbca5f779dd329d1d80ddac"></a>
class&#160;</td><td class="memItemRight" valign="bottom"><b>XMLOutputArchive</b></td></tr>
<tr class="separator:a7fe2c3c8bfbca5f779dd329d1d80ddac"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>A class containing various advanced options for the XML archive. </p>
<p><a class="el" href="classcereal_1_1XMLOutputArchive_1_1Options.html" title="A class containing various advanced options for the XML archive.">Options</a> can either be directly passed to the constructor, or chained using the modifier functions for an interface analogous to named parameters </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="ad0720fae6be971e51ca8230b3868b894"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad0720fae6be971e51ca8230b3868b894">&#9670;&nbsp;</a></span>Options()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">cereal::XMLOutputArchive::Options::Options </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>precision_</em> = <code>std::numeric_limits&lt;double&gt;::max_digits10</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>indent_</em> = <code>true</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>outputType_</em> = <code>false</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>sizeAttributes_</em> = <code>true</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>Specify specific options for the <a class="el" href="classcereal_1_1XMLOutputArchive.html" title="An output archive designed to save data to XML.">XMLOutputArchive</a>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">precision_</td><td>The precision used for floating point numbers </td></tr>
<tr><td class="paramname">indent_</td><td>Whether to indent each line of XML </td></tr>
<tr><td class="paramname">outputType_</td><td>Whether to output the type of each serialized object as an attribute </td></tr>
<tr><td class="paramname">sizeAttributes_</td><td>Whether dynamically sized containers output the size=dynamic attribute </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="xml_8hpp_source.html">xml.hpp</a></li>
</ul>
</div><!-- contents -->
<div class="ttc" id="aclasscereal_1_1XMLOutputArchive_1_1Options_html"><div class="ttname"><a href="classcereal_1_1XMLOutputArchive_1_1Options.html">cereal::XMLOutputArchive::Options</a></div><div class="ttdoc">A class containing various advanced options for the XML archive.</div><div class="ttdef"><b>Definition:</b> xml.hpp:106</div></div>
<div class="ttc" id="aclasscereal_1_1XMLOutputArchive_1_1Options_html_a46c5745849c2a6dafb24c1010a984f03"><div class="ttname"><a href="classcereal_1_1XMLOutputArchive_1_1Options.html#a46c5745849c2a6dafb24c1010a984f03">cereal::XMLOutputArchive::Options::sizeAttributes</a></div><div class="ttdeci">Options &amp; sizeAttributes(bool enable)</div><div class="ttdoc">Whether dynamically sized containers (e.g. vector) output the size=dynamic attribute.</div><div class="ttdef"><b>Definition:</b> xml.hpp:146</div></div>
<div class="ttc" id="aclasscereal_1_1XMLOutputArchive_1_1Options_html_a926a95d1282e4e34707b989f911158ff"><div class="ttname"><a href="classcereal_1_1XMLOutputArchive_1_1Options.html#a926a95d1282e4e34707b989f911158ff">cereal::XMLOutputArchive::Options::indent</a></div><div class="ttdeci">Options &amp; indent(bool enable)</div><div class="ttdoc">Whether to indent each line of XML.</div><div class="ttdef"><b>Definition:</b> xml.hpp:142</div></div>
<div class="ttc" id="aclasscereal_1_1XMLOutputArchive_html"><div class="ttname"><a href="classcereal_1_1XMLOutputArchive.html">cereal::XMLOutputArchive</a></div><div class="ttdoc">An output archive designed to save data to XML.</div><div class="ttdef"><b>Definition:</b> xml.hpp:96</div></div>
<!-- HTML footer for doxygen 1.8.3.1-->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sun Feb 27 2022 19:46:46 for cereal by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-42360142-1', 'uscilab.github.io');
ga('send', 'pageview');
</script>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink