| <!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>Avro C++: avro::ValidSchema 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">Avro C++ |
| </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"><a class="el" href="namespaceavro.html">avro</a></li><li class="navelem"><a class="el" href="classavro_1_1ValidSchema.html">ValidSchema</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="#pro-attribs">Protected Attributes</a> | |
| <a href="classavro_1_1ValidSchema-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">avro::ValidSchema Class Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>A <a class="el" href="classavro_1_1ValidSchema.html" title="A ValidSchema is basically a non-mutable Schema that has passed some minimum of sanity checks...">ValidSchema</a> is basically a non-mutable <a class="el" href="classavro_1_1Schema.html" title="The root Schema object is a base class. Nobody constructs this class directly. ">Schema</a> that has passed some minimum of sanity checks. |
| <a href="classavro_1_1ValidSchema.html#details">More...</a></p> |
| |
| <p><code>#include <<a class="el" href="ValidSchema_8hh_source.html">ValidSchema.hh</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:a0eee18f8556a955dce60d142b9c74079"><td class="memItemLeft" align="right" valign="top"><a id="a0eee18f8556a955dce60d142b9c74079"></a> |
|  </td><td class="memItemRight" valign="bottom"><b>ValidSchema</b> (const NodePtr &root)</td></tr> |
| <tr class="separator:a0eee18f8556a955dce60d142b9c74079"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a550f9aad9662d9edc552c62f2caea074"><td class="memItemLeft" align="right" valign="top"><a id="a550f9aad9662d9edc552c62f2caea074"></a> |
|  </td><td class="memItemRight" valign="bottom"><b>ValidSchema</b> (const <a class="el" href="classavro_1_1Schema.html">Schema</a> &schema)</td></tr> |
| <tr class="separator:a550f9aad9662d9edc552c62f2caea074"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a2a3587c6cf22e1615bae57ebbe4818f4"><td class="memItemLeft" align="right" valign="top"><a id="a2a3587c6cf22e1615bae57ebbe4818f4"></a> |
| void </td><td class="memItemRight" valign="bottom"><b>setSchema</b> (const <a class="el" href="classavro_1_1Schema.html">Schema</a> &schema)</td></tr> |
| <tr class="separator:a2a3587c6cf22e1615bae57ebbe4818f4"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:acc379267f9f185a43bc49fba10319cbf"><td class="memItemLeft" align="right" valign="top"><a id="acc379267f9f185a43bc49fba10319cbf"></a> |
| const NodePtr & </td><td class="memItemRight" valign="bottom"><b>root</b> () const</td></tr> |
| <tr class="separator:acc379267f9f185a43bc49fba10319cbf"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a43de6131be25e1bd8f68f36f76ce54b8"><td class="memItemLeft" align="right" valign="top"><a id="a43de6131be25e1bd8f68f36f76ce54b8"></a> |
| void </td><td class="memItemRight" valign="bottom"><b>toJson</b> (std::ostream &os) const</td></tr> |
| <tr class="separator:a43de6131be25e1bd8f68f36f76ce54b8"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a560e3d751b4ad6d9f9a0fd75d3a7990c"><td class="memItemLeft" align="right" valign="top"><a id="a560e3d751b4ad6d9f9a0fd75d3a7990c"></a> |
| std::string </td><td class="memItemRight" valign="bottom"><b>toJson</b> (bool prettyPrint=true) const</td></tr> |
| <tr class="separator:a560e3d751b4ad6d9f9a0fd75d3a7990c"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a4b78b055b6742f962ca516c26395c6b5"><td class="memItemLeft" align="right" valign="top"><a id="a4b78b055b6742f962ca516c26395c6b5"></a> |
| void </td><td class="memItemRight" valign="bottom"><b>toFlatList</b> (std::ostream &os) const</td></tr> |
| <tr class="separator:a4b78b055b6742f962ca516c26395c6b5"><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:a286b14fb4121101d513e25b820e2f6d3"><td class="memItemLeft" align="right" valign="top"><a id="a286b14fb4121101d513e25b820e2f6d3"></a> |
| NodePtr </td><td class="memItemRight" valign="bottom"><b>root_</b></td></tr> |
| <tr class="separator:a286b14fb4121101d513e25b820e2f6d3"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>A <a class="el" href="classavro_1_1ValidSchema.html" title="A ValidSchema is basically a non-mutable Schema that has passed some minimum of sanity checks...">ValidSchema</a> is basically a non-mutable <a class="el" href="classavro_1_1Schema.html" title="The root Schema object is a base class. Nobody constructs this class directly. ">Schema</a> that has passed some minimum of sanity checks. </p> |
| <p>Once validated, any <a class="el" href="classavro_1_1Schema.html" title="The root Schema object is a base class. Nobody constructs this class directly. ">Schema</a> that is part of this <a class="el" href="classavro_1_1ValidSchema.html" title="A ValidSchema is basically a non-mutable Schema that has passed some minimum of sanity checks...">ValidSchema</a> is considered locked, and cannot be modified (an attempt to modify a locked <a class="el" href="classavro_1_1Schema.html" title="The root Schema object is a base class. Nobody constructs this class directly. ">Schema</a> will throw). Also, as it is validated, any recursive duplications of schemas are replaced with symbolic links to the original.</p> |
| <p>Once a <a class="el" href="classavro_1_1Schema.html" title="The root Schema object is a base class. Nobody constructs this class directly. ">Schema</a> is converted to a valid schema it can be used in validating parsers/serializers, converted to a json schema, etc. </p> |
| </div><hr/>The documentation for this class was generated from the following file:<ul> |
| <li>api/<a class="el" href="ValidSchema_8hh_source.html">ValidSchema.hh</a></li> |
| </ul> |
| </div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated 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> |
