| <!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::DataFileReaderBase 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_1DataFileReaderBase.html">DataFileReaderBase</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="classavro_1_1DataFileReaderBase-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">avro::DataFileReaderBase Class Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>The type independent portion of rader. |
| <a href="classavro_1_1DataFileReaderBase.html#details">More...</a></p> |
| |
| <p><code>#include <<a class="el" href="DataFile_8hh_source.html">DataFile.hh</a>></code></p> |
| <div class="dynheader"> |
| Inheritance diagram for avro::DataFileReaderBase:</div> |
| <div class="dyncontent"> |
| <div class="center"> |
| <img src="classavro_1_1DataFileReaderBase.png" usemap="#avro::DataFileReaderBase_map" alt=""/> |
| <map id="avro::DataFileReaderBase_map" name="avro::DataFileReaderBase_map"> |
| </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:adc7d7c531fec38d38bdc199050587265"><td class="memItemLeft" align="right" valign="top"><a id="adc7d7c531fec38d38bdc199050587265"></a> |
| <a class="el" href="classavro_1_1Decoder.html">Decoder</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classavro_1_1DataFileReaderBase.html#adc7d7c531fec38d38bdc199050587265">decoder</a> ()</td></tr> |
| <tr class="memdesc:adc7d7c531fec38d38bdc199050587265"><td class="mdescLeft"> </td><td class="mdescRight">Returns the current decoder for this reader. <br /></td></tr> |
| <tr class="separator:adc7d7c531fec38d38bdc199050587265"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a8dd0cb6fa75a4090dcf4460484853b24"><td class="memItemLeft" align="right" valign="top"><a id="a8dd0cb6fa75a4090dcf4460484853b24"></a> |
| bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classavro_1_1DataFileReaderBase.html#a8dd0cb6fa75a4090dcf4460484853b24">hasMore</a> ()</td></tr> |
| <tr class="memdesc:a8dd0cb6fa75a4090dcf4460484853b24"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if and only if there is more to read. <br /></td></tr> |
| <tr class="separator:a8dd0cb6fa75a4090dcf4460484853b24"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aef936c83dfefadfd1814686fbf6b049d"><td class="memItemLeft" align="right" valign="top"><a id="aef936c83dfefadfd1814686fbf6b049d"></a> |
| void </td><td class="memItemRight" valign="bottom"><a class="el" href="classavro_1_1DataFileReaderBase.html#aef936c83dfefadfd1814686fbf6b049d">decr</a> ()</td></tr> |
| <tr class="memdesc:aef936c83dfefadfd1814686fbf6b049d"><td class="mdescLeft"> </td><td class="mdescRight">Decrements the number of objects yet to read. <br /></td></tr> |
| <tr class="separator:aef936c83dfefadfd1814686fbf6b049d"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:af8cf08b6297b84a78efdc23846a933d3"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classavro_1_1DataFileReaderBase.html#af8cf08b6297b84a78efdc23846a933d3">DataFileReaderBase</a> (const char *filename)</td></tr> |
| <tr class="memdesc:af8cf08b6297b84a78efdc23846a933d3"><td class="mdescLeft"> </td><td class="mdescRight">Constructs the reader for the given file and the reader is expected to use the schema that is used with data. <a href="#af8cf08b6297b84a78efdc23846a933d3">More...</a><br /></td></tr> |
| <tr class="separator:af8cf08b6297b84a78efdc23846a933d3"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a3a129ba76401b823c64aa63f649b6737"><td class="memItemLeft" align="right" valign="top"><a id="a3a129ba76401b823c64aa63f649b6737"></a> |
|  </td><td class="memItemRight" valign="bottom"><b>DataFileReaderBase</b> (std::unique_ptr< <a class="el" href="classavro_1_1InputStream.html">InputStream</a> > inputStream)</td></tr> |
| <tr class="separator:a3a129ba76401b823c64aa63f649b6737"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a653f576982968e7ad5acd01b7e9db86d"><td class="memItemLeft" align="right" valign="top"><a id="a653f576982968e7ad5acd01b7e9db86d"></a> |
| void </td><td class="memItemRight" valign="bottom"><a class="el" href="classavro_1_1DataFileReaderBase.html#a653f576982968e7ad5acd01b7e9db86d">init</a> ()</td></tr> |
| <tr class="memdesc:a653f576982968e7ad5acd01b7e9db86d"><td class="mdescLeft"> </td><td class="mdescRight">Initializes the reader so that the reader and writer schemas are the same. <br /></td></tr> |
| <tr class="separator:a653f576982968e7ad5acd01b7e9db86d"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a432b65070ff58dd4cf3ef0d776bdd0cc"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classavro_1_1DataFileReaderBase.html#a432b65070ff58dd4cf3ef0d776bdd0cc">init</a> (const <a class="el" href="classavro_1_1ValidSchema.html">ValidSchema</a> &<a class="el" href="classavro_1_1DataFileReaderBase.html#a29930afeae18d2126de0904fa6ab4c33">readerSchema</a>)</td></tr> |
| <tr class="memdesc:a432b65070ff58dd4cf3ef0d776bdd0cc"><td class="mdescLeft"> </td><td class="mdescRight">Initializes the reader to read objects according to the given schema. <a href="#a432b65070ff58dd4cf3ef0d776bdd0cc">More...</a><br /></td></tr> |
| <tr class="separator:a432b65070ff58dd4cf3ef0d776bdd0cc"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a29930afeae18d2126de0904fa6ab4c33"><td class="memItemLeft" align="right" valign="top"><a id="a29930afeae18d2126de0904fa6ab4c33"></a> |
| const <a class="el" href="classavro_1_1ValidSchema.html">ValidSchema</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classavro_1_1DataFileReaderBase.html#a29930afeae18d2126de0904fa6ab4c33">readerSchema</a> ()</td></tr> |
| <tr class="memdesc:a29930afeae18d2126de0904fa6ab4c33"><td class="mdescLeft"> </td><td class="mdescRight">Returns the schema for this object. <br /></td></tr> |
| <tr class="separator:a29930afeae18d2126de0904fa6ab4c33"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a3dc4f150d054cde439eed281230623ab"><td class="memItemLeft" align="right" valign="top"><a id="a3dc4f150d054cde439eed281230623ab"></a> |
| const <a class="el" href="classavro_1_1ValidSchema.html">ValidSchema</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classavro_1_1DataFileReaderBase.html#a3dc4f150d054cde439eed281230623ab">dataSchema</a> ()</td></tr> |
| <tr class="memdesc:a3dc4f150d054cde439eed281230623ab"><td class="mdescLeft"> </td><td class="mdescRight">Returns the schema stored with the data file. <br /></td></tr> |
| <tr class="separator:a3dc4f150d054cde439eed281230623ab"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ad10eaf9462e2464c37d3a1f4eebc702b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classavro_1_1DataFileReaderBase.html#ad10eaf9462e2464c37d3a1f4eebc702b">close</a> ()</td></tr> |
| <tr class="memdesc:ad10eaf9462e2464c37d3a1f4eebc702b"><td class="mdescLeft"> </td><td class="mdescRight">Closes the reader. <a href="#ad10eaf9462e2464c37d3a1f4eebc702b">More...</a><br /></td></tr> |
| <tr class="separator:ad10eaf9462e2464c37d3a1f4eebc702b"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a6f2a03aeed93d71d002c429b26eeeb3d"><td class="memItemLeft" align="right" valign="top"><a id="a6f2a03aeed93d71d002c429b26eeeb3d"></a> |
| void </td><td class="memItemRight" valign="bottom"><a class="el" href="classavro_1_1DataFileReaderBase.html#a6f2a03aeed93d71d002c429b26eeeb3d">seek</a> (int64_t position)</td></tr> |
| <tr class="memdesc:a6f2a03aeed93d71d002c429b26eeeb3d"><td class="mdescLeft"> </td><td class="mdescRight">Move to a specific, known synchronization point, for example one returned from tell() after <a class="el" href="classavro_1_1DataFileReaderBase.html#aea54d09e5ea8a4d08d6bc32752844ebb" title="Move to the next synchronization point after a position. ">sync()</a>. <br /></td></tr> |
| <tr class="separator:a6f2a03aeed93d71d002c429b26eeeb3d"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aea54d09e5ea8a4d08d6bc32752844ebb"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classavro_1_1DataFileReaderBase.html#aea54d09e5ea8a4d08d6bc32752844ebb">sync</a> (int64_t position)</td></tr> |
| <tr class="memdesc:aea54d09e5ea8a4d08d6bc32752844ebb"><td class="mdescLeft"> </td><td class="mdescRight">Move to the next synchronization point after a position. <a href="#aea54d09e5ea8a4d08d6bc32752844ebb">More...</a><br /></td></tr> |
| <tr class="separator:aea54d09e5ea8a4d08d6bc32752844ebb"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aaae611991f7b24c8f7f5f3e0e59970df"><td class="memItemLeft" align="right" valign="top"><a id="aaae611991f7b24c8f7f5f3e0e59970df"></a> |
| bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classavro_1_1DataFileReaderBase.html#aaae611991f7b24c8f7f5f3e0e59970df">pastSync</a> (int64_t position)</td></tr> |
| <tr class="memdesc:aaae611991f7b24c8f7f5f3e0e59970df"><td class="mdescLeft"> </td><td class="mdescRight">Return true if past the next synchronization point after a position. <br /></td></tr> |
| <tr class="separator:aaae611991f7b24c8f7f5f3e0e59970df"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ad8c9b2294934574057274a41f6ad284d"><td class="memItemLeft" align="right" valign="top"><a id="ad8c9b2294934574057274a41f6ad284d"></a> |
| int64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classavro_1_1DataFileReaderBase.html#ad8c9b2294934574057274a41f6ad284d">previousSync</a> ()</td></tr> |
| <tr class="memdesc:ad8c9b2294934574057274a41f6ad284d"><td class="mdescLeft"> </td><td class="mdescRight">Return the last synchronization point before our current position. <br /></td></tr> |
| <tr class="separator:ad8c9b2294934574057274a41f6ad284d"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>The type independent portion of rader. </p> |
| </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> |
| <a id="af8cf08b6297b84a78efdc23846a933d3"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#af8cf08b6297b84a78efdc23846a933d3">◆ </a></span>DataFileReaderBase()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">avro::DataFileReaderBase::DataFileReaderBase </td> |
| <td>(</td> |
| <td class="paramtype">const char * </td> |
| <td class="paramname"><em>filename</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Constructs the reader for the given file and the reader is expected to use the schema that is used with data. </p> |
| <p>This function should be called exactly once after constructing the <a class="el" href="classavro_1_1DataFileReaderBase.html" title="The type independent portion of rader. ">DataFileReaderBase</a> object. </p> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Function Documentation</h2> |
| <a id="ad10eaf9462e2464c37d3a1f4eebc702b"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ad10eaf9462e2464c37d3a1f4eebc702b">◆ </a></span>close()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void avro::DataFileReaderBase::close </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Closes the reader. </p> |
| <p>No further operation is possible on this reader. </p> |
| |
| </div> |
| </div> |
| <a id="a432b65070ff58dd4cf3ef0d776bdd0cc"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a432b65070ff58dd4cf3ef0d776bdd0cc">◆ </a></span>init()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void avro::DataFileReaderBase::init </td> |
| <td>(</td> |
| <td class="paramtype">const <a class="el" href="classavro_1_1ValidSchema.html">ValidSchema</a> & </td> |
| <td class="paramname"><em>readerSchema</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Initializes the reader to read objects according to the given schema. </p> |
| <p>This gives an opportinity for the reader to see the schema in the data file before deciding the right schema to use for reading. This must be called exactly once after constructing the <a class="el" href="classavro_1_1DataFileReaderBase.html" title="The type independent portion of rader. ">DataFileReaderBase</a> object. </p> |
| |
| </div> |
| </div> |
| <a id="aea54d09e5ea8a4d08d6bc32752844ebb"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aea54d09e5ea8a4d08d6bc32752844ebb">◆ </a></span>sync()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void avro::DataFileReaderBase::sync </td> |
| <td>(</td> |
| <td class="paramtype">int64_t </td> |
| <td class="paramname"><em>position</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Move to the next synchronization point after a position. </p> |
| <p>To process a range of file entires, call this with the starting position, then check <a class="el" href="classavro_1_1DataFileReaderBase.html#aaae611991f7b24c8f7f5f3e0e59970df" title="Return true if past the next synchronization point after a position. ">pastSync()</a> with the end point before each use of <a class="el" href="classavro_1_1DataFileReaderBase.html#adc7d7c531fec38d38bdc199050587265" title="Returns the current decoder for this reader. ">decoder()</a>. </p> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following file:<ul> |
| <li>api/<a class="el" href="DataFile_8hh_source.html">DataFile.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> |
