libAthena
/
athena
mirror of https://github.com/libAthena/athena.git
2
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
athena/_file_reader_8hpp_source.html

128 lines
18 KiB
HTML
Raw Normal View History

Update docs
2016-09-17 20:12:02 +00:00
<!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.11"/>
<title>Athena IO Library: include/athena/FileReader.hpp Source File</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">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</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">
$(document).ready(function() { init_search(); });
</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">Athena IO Library
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.11 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li>
<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>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File&#160;List</span></a></li>
</ul>
</div>
</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">
$(document).ready(function(){initNavTree('_file_reader_8hpp_source.html','');});
</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="headertitle">
<div class="title">FileReader.hpp</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="preprocessor">#ifndef FILESTREAM_HPP</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="preprocessor">#define FILESTREAM_HPP</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;</div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="preprocessor">#include &lt;string&gt;</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="preprocessor">#include &lt;memory&gt;</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="preprocessor">#include &lt;stdio.h&gt;</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="preprocessor">#include &quot;athena/IStreamReader.hpp&quot;</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;</div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespaceathena.html">athena</a></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;{</div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="keyword">namespace </span>io</div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;{</div><div class="line"><a name="l00013"></a><span class="lineno"><a class="line" href="classathena_1_1io_1_1_file_reader.html"> 13</a></span>&#160;<span class="keyword">class </span><a class="code" href="classathena_1_1io_1_1_file_reader.html">FileReader</a> : <span class="keyword">public</span> <a class="code" href="classathena_1_1io_1_1_i_stream_reader.html">IStreamReader</a></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;{</div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="keyword">public</span>:</div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160; <a class="code" href="classathena_1_1io_1_1_file_reader.html">FileReader</a>(<span class="keyword">const</span> std::string&amp; filename, atInt32 cacheSize = (32 * 1024), <span class="keywordtype">bool</span> globalErr=<span class="keyword">true</span>);</div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160; <a class="code" href="classathena_1_1io_1_1_file_reader.html">FileReader</a>(<span class="keyword">const</span> std::wstring&amp; filename, atInt32 cacheSize = (32 * 1024), <span class="keywordtype">bool</span> globalErr=<span class="keyword">true</span>);</div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160; <span class="keyword">virtual</span> ~<a class="code" href="classathena_1_1io_1_1_file_reader.html">FileReader</a>();</div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;</div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160; <span class="keyword">inline</span> std::string filename()<span class="keyword"> const</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="keyword"> </span>{</div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;<span class="preprocessor">#if _WIN32</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160; <span class="keywordflow">return</span> utility::wideToUtf8(m_filename);</div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="preprocessor">#else</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160; <span class="keywordflow">return</span> m_filename;</div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;<span class="preprocessor">#endif</span></div><div class="line"><a
<div class="ttc" id="classathena_1_1io_1_1_file_reader_html_a7077560fb12c77ef36acfa75076725e2"><div class="ttname"><a href="classathena_1_1io_1_1_file_reader.html#a7077560fb12c77ef36acfa75076725e2">athena::io::FileReader::length</a></div><div class="ttdeci">atUint64 length() const </div><div class="ttdoc">Returns the length of the file. </div></div>
<div class="ttc" id="classathena_1_1io_1_1_i_stream_reader_html"><div class="ttname"><a href="classathena_1_1io_1_1_i_stream_reader.html">athena::io::IStreamReader</a></div><div class="ttdoc">The IStreamReader class defines a basic API for reading from streams, Implementors are provided with ...</div><div class="ttdef"><b>Definition:</b> <a href="_i_stream_reader_8hpp_source.html#l00018">IStreamReader.hpp:18</a></div></div>
<div class="ttc" id="namespaceathena_html"><div class="ttname"><a href="namespaceathena.html">athena</a></div><div class="ttdef"><b>Definition:</b> <a href="_a_l_t_t_p_enums_8hpp_source.html#l00006">ALTTPEnums.hpp:6</a></div></div>
<div class="ttc" id="classathena_1_1io_1_1_file_reader_html_a38c4949a6e442ff25a4019eb8b907bf4"><div class="ttname"><a href="classathena_1_1io_1_1_file_reader.html#a38c4949a6e442ff25a4019eb8b907bf4">athena::io::FileReader::seek</a></div><div class="ttdeci">void seek(atInt64 pos, SeekOrigin origin=SeekOrigin::Current)</div><div class="ttdoc">Sets the buffers position relative to the specified position. It seeks relative to the current posit...</div></div>
<div class="ttc" id="classathena_1_1io_1_1_file_reader_html_ac064f55711ec2237358bdc4842dc1ab3"><div class="ttname"><a href="classathena_1_1io_1_1_file_reader.html#ac064f55711ec2237358bdc4842dc1ab3">athena::io::FileReader::readUBytesToBuf</a></div><div class="ttdeci">atUint64 readUBytesToBuf(void *buf, atUint64 len)</div><div class="ttdoc">Attempts to read a fixed length of data into a pre-allocated buffer, this function is client defined ...</div></div>
<div class="ttc" id="classathena_1_1io_1_1_file_reader_html"><div class="ttname"><a href="classathena_1_1io_1_1_file_reader.html">athena::io::FileReader</a></div><div class="ttdef"><b>Definition:</b> <a href="_file_reader_8hpp_source.html#l00013">FileReader.hpp:13</a></div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_9b3fbfcb7fc609b7105d1ff63111043b.html">athena</a></li><li class="navelem"><b>FileReader.hpp</b></li>
<li class="footer">Generated on Sat Sep 17 2016 13:10:08 for Athena IO Library by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
</ul>
</div>
</body>
</html>