mirror of https://github.com/libAthena/athena.git
215 lines
16 KiB
HTML
215 lines
16 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: athena::io::IStream 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="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 class="current"><a href="annotated.html"><span>Classes</span></a></li>
|
||
|
|
<li><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="annotated.html"><span>Class List</span></a></li>
|
||
|
|
<li><a href="classes.html"><span>Class Index</span></a></li>
|
||
|
|
<li><a href="inherits.html"><span>Class Hierarchy</span></a></li>
|
||
|
|
<li><a href="functions.html"><span>Class Members</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('classathena_1_1io_1_1_i_stream.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="summary">
|
||
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
||
|
|
<a href="#pro-methods">Protected Member Functions</a> |
|
||
|
|
<a href="#pro-attribs">Protected Attributes</a> |
|
||
|
|
<a href="classathena_1_1io_1_1_i_stream-members.html">List of all members</a> </div>
|
||
|
|
<div class="headertitle">
|
||
|
|
<div class="title">athena::io::IStream Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
|
||
|
|
</div><!--header-->
|
||
|
|
<div class="contents">
|
||
|
|
<div class="dynheader">
|
||
|
|
Inheritance diagram for athena::io::IStream:</div>
|
||
|
|
<div class="dyncontent">
|
||
|
|
<div class="center"><img src="classathena_1_1io_1_1_i_stream__inherit__graph.png" border="0" usemap="#athena_1_1io_1_1_i_stream_inherit__map" alt="Inheritance graph"/></div>
|
||
|
|
<map name="athena_1_1io_1_1_i_stream_inherit__map" id="athena_1_1io_1_1_i_stream_inherit__map">
|
||
|
|
<area shape="rect" id="node2" href="classathena_1_1io_1_1_i_stream_reader.html" title="The IStreamReader class defines a basic API for reading from streams, Implementors are provided with ..." alt="" coords="763,307,954,531"/>
|
||
|
|
<area shape="rect" id="node12" href="classathena_1_1io_1_1_i_stream_writer.html" title="{athena::io::IStreamWriter\n||+ ~IStreamWriter()\l+ seek()\l+ seekAlign32()\l+ atEnd()\l+ position()\l+ length()\l+ writeUByte()\l+ writeVal()\l+ writeValLittle()\l+ writeValBig()\land 111 more...\l}" alt="" coords="1150,307,1335,531"/>
|
||
|
|
<area shape="rect" id="node3" href="classathena_1_1io_1_1_file_reader.html" title="{athena::io::FileReader\n|# m_filename\l# m_fileHandle\l# m_cacheData\l# m_blockSize\l# m_curBlock\l# m_offset\l# m_globalErr\l|+ FileReader()\l+ FileReader()\l+ ~FileReader()\l+ filename()\l+ wfilename()\l+ open()\l+ close()\l+ isOpen()\l+ save()\l+ seek()\l+ position()\l+ length()\l+ readUBytesToBuf()\l+ setCacheSize()\l+ _fileHandle()\l}" alt="" coords="575,579,737,949"/>
|
||
|
|
<area shape="rect" id="node4" href="classathena_1_1io_1_1_memory_reader.html" title="A Stream class for reading data from a memory position. " alt="" coords="762,637,955,891"/>
|
||
|
|
<area shape="rect" id="node5" href="classathena_1_1io_1_1_memory_copy_reader.html" title="{athena::io::MemoryCopyReader\n|# m_dataCopy\l# m_filepath\l|+ MemoryCopyReader()\l+ MemoryCopyReader()\l+ setData()\l# loadData()\l}" alt="" coords="659,997,885,1133"/>
|
||
|
|
<area shape="rect" id="node6" href="classathena_1_1io_1_1_a_l_t_t_p_file_reader.html" title="A Link to the Past save data reader class. " alt="" coords="5,1189,205,1295"/>
|
||
|
|
<area shape="rect" id="node7" href="classathena_1_1io_1_1_m_c_file_reader.html" title="The Minish Cap Save save data reader class. " alt="" coords="230,1189,413,1295"/>
|
||
|
|
<area shape="rect" id="node8" href="classathena_1_1io_1_1_skyward_sword_file_reader.html" title="{athena::io::SkywardSword\lFileReader\n||+ SkywardSwordFileReader()\l+ SkywardSwordFileReader()\l+ read()\l}" alt="" coords="437,1181,648,1303"/>
|
||
|
|
<area shape="rect" id="node9" href="classathena_1_1io_1_1_sprite_file_reader.html" title="{athena::io::SpriteFileReader\n||+ SpriteFileReader()\l+ SpriteFileReader()\l+ readFile()\l}" alt="" coords="672,1189,872,1295"/>
|
||
|
|
<area shape="rect" id="node10" href="classathena_1_1io_1_1_wii_save_reader.html" title="Wii data.bin reader class. " alt="" coords="897,1189,1090,1295"/>
|
||
|
|
<area shape="rect" id="node11" href="classathena_1_1io_1_1_z_quest_file_reader.html" title="The ZQuestFileReader class. " alt="" coords="1114,1189,1323,1295"/>
|
||
|
|
<area shape="rect" id="node13" href="classathena_1_1io_1_1_file_writer.html" title="{athena::io::FileWriter\n||+ FileWriter()\l+ FileWriter()\l+ ~FileWriter()\l+ filename()\l+ wfilename()\l+ open()\l+ close()\l+ isOpen()\l+ seek()\l+ position()\l+ length()\l+ writeUBytes()\l+ _fileHandle()\l}" alt="" coords="1165,637,1321,891"/>
|
||
|
|
<area shape="rect" id="node14" href="classathena_1_1io_1_1_memory_writer.html" title="A Stream class for writing data to a memory position. " alt="" coords="1689,608,1876,920"/>
|
||
|
|
<area shape="rect" id="node15" href="classathena_1_1io_1_1_memory_copy_writer.html" title="{athena::io::MemoryCopyWriter\n|# m_dataCopy\l|+ MemoryCopyWriter()\l+ MemoryCopyWriter()\l+ seek()\l+ setData()\l+ writeUBytes()\l}" alt="" coords="1759,997,1979,1133"/>
|
||
|
|
<area shape="rect" id="node16" href="classathena_1_1io_1_1_a_l_t_t_p_file_writer.html" title="A Link to the Past save data writer class. " alt="" coords="1348,1189,1543,1295"/>
|
||
|
|
<area shape="rect" id="node17" href="classathena_1_1io_1_1_m_c_file_writer.html" title="The Minish Cap Save save data writer class. " alt="" coords="1567,1181,1743,1303"/>
|
||
|
|
<area shape="rect" id="node18" href="classathena_1_1io_1_1_skyward_sword_file_writer.html" title="{athena::io::SkywardSword\lFileWriter\n||+ SkywardSwordFileWriter()\l+ SkywardSwordFileWriter()\l+ write()\l}" alt="" coords="1767,1181,1971,1303"/>
|
||
|
|
<area shape="rect" id="node19" href="classathena_1_1io_1_1_sprite_file_writer.html" title="{athena::io::SpriteFileWriter\n||+ SpriteFileWriter()\l+ SpriteFileWriter()\l+ writeFile()\l}" alt="" coords="1996,1189,2191,1295"/>
|
||
|
|
<area shape="rect" id="node20" href="classathena_1_1io_1_1_wii_save_writer.html" title="Wii data.bin writer class. " alt="" coords="2215,1196,2401,1288"/>
|
||
|
|
<area shape="rect" id="node21" href="classathena_1_1io_1_1_z_quest_file_writer.html" title="The ZQuestFileWriter class. " alt="" coords="2425,1189,2628,1295"/>
|
||
|
|
</map>
|
||
|
|
</div>
|
||
|
|
<div class="dynheader">
|
||
|
|
Collaboration diagram for athena::io::IStream:</div>
|
||
|
|
<div class="dyncontent">
|
||
|
|
<div class="center"><img src="classathena_1_1io_1_1_i_stream__coll__graph.png" border="0" usemap="#athena_1_1io_1_1_i_stream_coll__map" alt="Collaboration graph"/></div>
|
||
|
|
<map name="athena_1_1io_1_1_i_stream_coll__map" id="athena_1_1io_1_1_i_stream_coll__map">
|
||
|
|
</map>
|
||
|
|
</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:ac2beff267a6ac8991f088d2cd010bf59"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac2beff267a6ac8991f088d2cd010bf59"></a>
|
||
|
|
void </td><td class="memItemRight" valign="bottom"><b>setEndian</b> (Endian endian)</td></tr>
|
||
|
|
<tr class="separator:ac2beff267a6ac8991f088d2cd010bf59"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:ab230982b81f34d7ea53521006eb31a09"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab230982b81f34d7ea53521006eb31a09"></a>
|
||
|
|
Endian </td><td class="memItemRight" valign="bottom"><b>endian</b> () const </td></tr>
|
||
|
|
<tr class="separator:ab230982b81f34d7ea53521006eb31a09"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a2f850abc54c6eb53e3a0cb4aec8619d9"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2f850abc54c6eb53e3a0cb4aec8619d9"></a>
|
||
|
|
bool </td><td class="memItemRight" valign="bottom"><b>isBigEndian</b> () const </td></tr>
|
||
|
|
<tr class="separator:a2f850abc54c6eb53e3a0cb4aec8619d9"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a76bdbe0dcbe80698014b7b038591db72"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a76bdbe0dcbe80698014b7b038591db72"></a>
|
||
|
|
bool </td><td class="memItemRight" valign="bottom"><b>isLittleEndian</b> () const </td></tr>
|
||
|
|
<tr class="separator:a76bdbe0dcbe80698014b7b038591db72"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a5a314b500e4c90f0a7e37650bd1e604e"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5a314b500e4c90f0a7e37650bd1e604e"></a>
|
||
|
|
virtual void </td><td class="memItemRight" valign="bottom"><b>seek</b> (atInt64, SeekOrigin)=0</td></tr>
|
||
|
|
<tr class="separator:a5a314b500e4c90f0a7e37650bd1e604e"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a6290309a3ca7d8228a678163c786ad53"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6290309a3ca7d8228a678163c786ad53"></a>
|
||
|
|
virtual bool </td><td class="memItemRight" valign="bottom"><b>atEnd</b> () const =0</td></tr>
|
||
|
|
<tr class="separator:a6290309a3ca7d8228a678163c786ad53"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:aa948b74dc739f96ae2a40ed11fb978c0"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa948b74dc739f96ae2a40ed11fb978c0"></a>
|
||
|
|
virtual atUint64 </td><td class="memItemRight" valign="bottom"><b>position</b> () const =0</td></tr>
|
||
|
|
<tr class="separator:aa948b74dc739f96ae2a40ed11fb978c0"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a9e53ae82804e516cd14a61e80bc11251"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9e53ae82804e516cd14a61e80bc11251"></a>
|
||
|
|
virtual atUint64 </td><td class="memItemRight" valign="bottom"><b>length</b> () const =0</td></tr>
|
||
|
|
<tr class="separator:a9e53ae82804e516cd14a61e80bc11251"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:aaf5d44cdffbeb864a62c442a6e8e68ea"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aaf5d44cdffbeb864a62c442a6e8e68ea"></a>
|
||
|
|
bool </td><td class="memItemRight" valign="bottom"><b>hasError</b> () const </td></tr>
|
||
|
|
<tr class="separator:aaf5d44cdffbeb864a62c442a6e8e68ea"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
</table><table class="memberdecls">
|
||
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
|
||
|
|
Protected Member Functions</h2></td></tr>
|
||
|
|
<tr class="memitem:a2e7892edca216aef9ba3a20108defbbb"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2e7892edca216aef9ba3a20108defbbb"></a>
|
||
|
|
void </td><td class="memItemRight" valign="bottom"><b>setError</b> ()</td></tr>
|
||
|
|
<tr class="separator:a2e7892edca216aef9ba3a20108defbbb"><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:aba5eb4fdae1f1ef99a03707357372ee2"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aba5eb4fdae1f1ef99a03707357372ee2"></a>
|
||
|
|
bool </td><td class="memItemRight" valign="bottom"><b>m_hasError</b> = false</td></tr>
|
||
|
|
<tr class="separator:aba5eb4fdae1f1ef99a03707357372ee2"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a77b71fd50c9d9aaeb49fca48e1c6d728"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a77b71fd50c9d9aaeb49fca48e1c6d728"></a>
|
||
|
|
Endian </td><td class="memItemRight" valign="bottom"><b>m_endian</b> = BigEndian</td></tr>
|
||
|
|
<tr class="separator:a77b71fd50c9d9aaeb49fca48e1c6d728"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
</table>
|
||
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
||
|
|
<div class="textblock">
|
||
|
|
<p>Definition at line <a class="el" href="_i_stream_8hpp_source.html#l00012">12</a> of file <a class="el" href="_i_stream_8hpp_source.html">IStream.hpp</a>.</p>
|
||
|
|
</div><hr/>The documentation for this class was generated from the following file:<ul>
|
||
|
|
<li>include/athena/<a class="el" href="_i_stream_8hpp_source.html">IStream.hpp</a></li>
|
||
|
|
</ul>
|
||
|
|
</div><!-- contents -->
|
||
|
|
</div><!-- doc-content -->
|
||
|
|
<!-- start footer part -->
|
||
|
|
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
||
|
|
<ul>
|
||
|
|
<li class="navelem"><b>athena</b></li><li class="navelem"><b>io</b></li><li class="navelem"><a class="el" href="classathena_1_1io_1_1_i_stream.html">IStream</a></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>
|