mirror of https://github.com/libAthena/athena.git
133 lines
22 KiB
HTML
133 lines
22 KiB
HTML
|
<!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/MemoryReader.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 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 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('_memory_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">MemoryReader.hpp</div> </div>
|
||
|
|
</div><!--header-->
|
||
|
|
<div class="contents">
|
||
|
|
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="preprocessor">#ifndef MEMORYREADER_HPP</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="preprocessor">#define MEMORYREADER_HPP</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> </div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="preprocessor">#include <string></span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="preprocessor">#include <memory></span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="preprocessor">#include <functional></span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="preprocessor">#include "athena/IStreamReader.hpp"</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> </div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <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> {</div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="keyword">namespace </span>io</div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> {</div><div class="line"><a name="l00021"></a><span class="lineno"><a class="line" href="classathena_1_1io_1_1_memory_reader.html"> 21</a></span> <span class="keyword">class </span><a class="code" href="classathena_1_1io_1_1_memory_reader.html">MemoryReader</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="l00022"></a><span class="lineno"> 22</span> {</div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="keyword">protected</span>:</div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>  <a class="code" href="classathena_1_1io_1_1_memory_reader.html">MemoryReader</a>() = <span class="keywordflow">default</span>;</div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="keyword">public</span>:</div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>  <span class="keyword">virtual</span> ~<a class="code" href="classathena_1_1io_1_1_memory_reader.html">MemoryReader</a>();</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> </div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  <a class="code" href="classathena_1_1io_1_1_memory_reader.html">MemoryReader</a>(<span class="keyword">const</span> <span class="keywordtype">void</span>* <a class="code" href="classathena_1_1io_1_1_memory_reader.html#a0ec143d492341f61cd3acef61afe8358">data</a>, atUint64 <a class="code" href="classathena_1_1io_1_1_memory_reader.html#a2f0f0efc43af6000fc68f16db258e50c">length</a>, <span class="keywordtype">bool</span> takeOwnership=<span class="keyword">false</span>, <span class="keywordtype">bool</span> globalErr=<span class="keyword">true</span>);</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> </div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <span class="keywordtype">void</span> <a class="code" href="classathena_1_1io_1_1_memory_reader.html#a47ee0f076c1639fa15d9233cf7d3b470">seek</a>(atInt64 pos, SeekOrigin origin = SeekOrigin::Current);</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> </div><div class="line"><a name="l00047"></a><span class="lineno"><a class="line" href="classathena_1_1io_1_1_memory_reader.html#a459addc7be3dc1918f995ebae5e0c6ae"> 47</a></span>  <span class="keyword">inline</span> atUint64 <a class="
|
||
|
|
<div class="ttc" id="classathena_1_1io_1_1_memory_reader_html_af3f62edd3db169a3276e7e3f230c930c"><div class="ttname"><a href="classathena_1_1io_1_1_memory_reader.html#af3f62edd3db169a3276e7e3f230c930c">athena::io::MemoryReader::readUBytesToBuf</a></div><div class="ttdeci">atUint64 readUBytesToBuf(void *buf, atUint64 len)</div><div class="ttdoc">Reads a specified number of bytes to user-allocated buffer. </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_memory_reader_html_a47ee0f076c1639fa15d9233cf7d3b470"><div class="ttname"><a href="classathena_1_1io_1_1_memory_reader.html#a47ee0f076c1639fa15d9233cf7d3b470">athena::io::MemoryReader::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_memory_copy_reader_html"><div class="ttname"><a href="classathena_1_1io_1_1_memory_copy_reader.html">athena::io::MemoryCopyReader</a></div><div class="ttdef"><b>Definition:</b> <a href="_memory_reader_8hpp_source.html#l00095">MemoryReader.hpp:95</a></div></div>
|
||
|
|
<div class="ttc" id="classathena_1_1io_1_1_memory_copy_reader_html_a6eedbe56523555b6e74388a985f320ce"><div class="ttname"><a href="classathena_1_1io_1_1_memory_copy_reader.html#a6eedbe56523555b6e74388a985f320ce">athena::io::MemoryCopyReader::m_filepath</a></div><div class="ttdeci">std::string m_filepath</div><div class="ttdoc">Path to the target file. </div><div class="ttdef"><b>Definition:</b> <a href="_memory_reader_8hpp_source.html#l00118">MemoryReader.hpp:118</a></div></div>
|
||
|
|
<div class="ttc" id="classathena_1_1io_1_1_memory_reader_html_a459addc7be3dc1918f995ebae5e0c6ae"><div class="ttname"><a href="classathena_1_1io_1_1_memory_reader.html#a459addc7be3dc1918f995ebae5e0c6ae">athena::io::MemoryReader::position</a></div><div class="ttdeci">atUint64 position() const </div><div class="ttdoc">Returns the current position in the stream. </div><div class="ttdef"><b>Definition:</b> <a href="_memory_reader_8hpp_source.html#l00047">MemoryReader.hpp:47</a></div></div>
|
||
|
|
<div class="ttc" id="classathena_1_1io_1_1_memory_reader_html_a0ec143d492341f61cd3acef61afe8358"><div class="ttname"><a href="classathena_1_1io_1_1_memory_reader.html#a0ec143d492341f61cd3acef61afe8358">athena::io::MemoryReader::data</a></div><div class="ttdeci">atUint8 * data() const </div><div class="ttdoc">Returns a copy of the current buffer. Changes to the copy do not affect the buffer so it&#39;s perfectly...</div></div>
|
||
|
|
<div class="ttc" id="classathena_1_1io_1_1_memory_reader_html_a2f0f0efc43af6000fc68f16db258e50c"><div class="ttname"><a href="classathena_1_1io_1_1_memory_reader.html#a2f0f0efc43af6000fc68f16db258e50c">athena::io::MemoryReader::length</a></div><div class="ttdeci">atUint64 length() const </div><div class="ttdoc">Returns whether or not the stream is at the end. </div><div class="ttdef"><b>Definition:</b> <a href="_memory_reader_8hpp_source.html#l00054">MemoryReader.hpp:54</a></div></div>
|
||
|
|
<div class="ttc" id="classathena_1_1io_1_1_memory_reader_html"><div class="ttname"><a href="classathena_1_1io_1_1_memory_reader.html">athena::io::MemoryReader</a></div><div class="ttdoc">A Stream class for reading data from a memory position. </div><div class="ttdef"><b>Definition:</b> <a href="_memory_reader_8hpp_source.html#l00021">MemoryReader.hpp:21</a></div></div>
|
||
|
|
<div class="ttc" id="classathena_1_1io_1_1_memory_copy_reader_html_a0789f11bb0033bc9eaa3fec24b6b3768"><div class="ttname"><a href="classathena_1_1io_1_1_memory_copy_reader.html#a0789f11bb0033bc9eaa3fec24b6b3768">athena::io::MemoryCopyReader::MemoryCopyReader</a></div><div class="ttdeci">MemoryCopyReader(const std::string &filename)</div><div class="ttdoc">This constructor creates an instance from a file on disk. </div><div class="ttdef"><b>Definition:</b> <a href="_memory_reader_8hpp_source.html#l00109">MemoryReader.hpp:109</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>MemoryReader.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>
|