mirror of
https://github.com/libAthena/athena.git
synced 2025-08-27 05:55:49 +00:00
179 lines
14 KiB
HTML
179 lines
14 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.9.1"/>
|
|
<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 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.9.1 -->
|
|
<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('class_athena_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="class_athena_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="class_athena_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="class_athena_1_1io_1_1_i_stream_reader.html" title="{Athena::io::IStreamReader\n||+ ~IStreamReader()\l+ setEndian()\l+ endian()\l+ isBigEndian()\l+ isLittleEndian()\l+ isOpen()\l+ seek()\l+ seekAlign32()\l+ atEnd()\l+ position()\land 20 more...\l}" alt="" coords="693,277,891,501"/><area shape="rect" id="node11" href="class_athena_1_1io_1_1_i_stream_writer.html" title="{Athena::io::IStreamWriter\n||+ ~IStreamWriter()\l+ setEndian()\l+ endian()\l+ isBigEndian()\l+ isLittleEndian()\l+ isOpen()\l+ seek()\l+ seekAlign32()\l+ atEnd()\l+ position()\land 20 more...\l}" alt="" coords="1267,277,1458,501"/><area shape="rect" id="node3" href="class_athena_1_1io_1_1_file_reader.html" title="{Athena::io::FileReader\n|# m_filename\l# m_fileHandle\l# m_endian\l# m_currentByte\l# m_bitShift\l# m_bitValid\l|+ FileReader()\l+ ~FileReader()\l+ filename()\l+ setEndian()\l+ endian()\l+ isBigEndian()\l+ isLittleEndian()\l+ open()\l+ close()\l+ isOpen()\land 25 more...\l}" alt="" coords="498,564,667,861"/><area shape="rect" id="node4" href="class_athena_1_1io_1_1_memory_reader.html" title="{Athena::io::MemoryReader\n|# m_data\l# m_length\l# m_filepath\l# m_position\l# m_bitPosition\l# m_endian\l# m_progressCallback\l|+ MemoryReader()\l+ MemoryReader()\l+ ~MemoryReader()\l+ setEndian()\l+ endian()\l+ isBigEndian()\l+ isLittleEndian()\l+ isOpen()\l+ seek()\l+ seekAlign32()\land 27 more...\l# loadData()\l}" alt="" coords="691,549,893,876"/><area shape="rect" id="node5" href="class_athena_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,931,216,1038"/><area shape="rect" id="node6" href="class_athena_1_1io_1_1_m_c_file_reader.html" title="The Minish Cap Save save data reader class. " alt="" coords="240,931,429,1038"/><area shape="rect" id="node7" href="class_athena_1_1io_1_1_skyward_sword_file_reader.html" title="{Athena::io::SkywardSword\lFileReader\n||+ SkywardSwordFileReader()\l+ SkywardSwordFileReader()\l+ read()\l}" alt="" coords="453,924,664,1045"/><area shape="rect" id="node8" href="class_athena_1_1io_1_1_sprite_file_reader.html" title="{Athena::io::SpriteFileReader\n||+ SpriteFileReader()\l+ SpriteFileReader()\l+ readFile()\l}" alt="" coords="689,931,895,1038"/><area shape="rect" id="node9" href="class_athena_1_1io_1_1_wii_save_reader.html" title="Wii data.bin reader class. " alt="" coords="919,931,1118,1038"/><area shape="rect" id="node10" href="class_athena_1_1io_1_1_z_quest_file_reader.html" title="The ZQuestFileReader class. " alt="" coords="1142,931,1359,1038"/><area shape="rect" id="node12" href="class_athena_1_1io_1_1_file_writer.html" title="{Athena::io::FileWriter\n||+ FileWriter()\l+ ~FileWriter()\l+ setEndian()\l+ endian()\l+ isBigEndian()\l+ isLittleEndian()\l+ open()\l+ close()\l+ isOpen()\l+ seek()\land 23 more...\l}" alt="" coords="1282,601,1443,825"/><area shape="rect" id="node13" href="class_athena_1_1io_1_1_memory_writer.html" title="{Athena::io::MemoryWriter\n|# m_data\l# m_length\l# m_filepath\l# m_position\l# m_bitPosition\l# m_endian\l# m_progressCallback\l|+ MemoryWriter()\l+ MemoryWriter()\l+ ~MemoryWriter()\l+ setEndian()\l+ endian()\l+ isBigEndian()\l+ isLittleEndian()\l+ isOpen()\l+ seek()\l+ seekAlign32()\land 28 more...\l# loadData()\l}" alt="" coords="1821,549,2014,876"/><area shape="rect" id="node14" href="class_athena_1_1io_1_1_a_l_t_t_p_file_writer.html" title="A Link to the Past save data writer class. " alt="" coords="1384,931,1587,1038"/><area shape="rect" id="node15" href="class_athena_1_1io_1_1_m_c_file_writer.html" title="The Minish Cap Save save data writer class. " alt="" coords="1611,924,1792,1045"/><area shape="rect" id="node16" href="class_athena_1_1io_1_1_skyward_sword_file_writer.html" title="{Athena::io::SkywardSword\lFileWriter\n||+ SkywardSwordFileWriter()\l+ SkywardSwordFileWriter()\l+ write()\l}" alt="" coords="1816,924,2019,1045"/><area shape="rect" id="node17" href="class_athena_1_1io_1_1_sprite_file_writer.html" title="{Athena::io::SpriteFileWriter\n||+ SpriteFileWriter()\l+ SpriteFileWriter()\l+ writeFile()\l}" alt="" coords="2043,931,2242,1038"/><area shape="rect" id="node18" href="class_athena_1_1io_1_1_wii_save_writer.html" title="Wii data.bin writer class. " alt="" coords="2266,939,2457,1031"/><area shape="rect" id="node19" href="class_athena_1_1io_1_1_z_quest_file_writer.html" title="The ZQuestFileWriter class. " alt="" coords="2481,931,2690,1038"/></map>
|
|
</div>
|
|
<div class="dynheader">
|
|
Collaboration diagram for Athena::io::IStream:</div>
|
|
<div class="dyncontent">
|
|
<div class="center"><img src="class_athena_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>
|
|
</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:ac76ed9270e120203a233a8828e910b50"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac76ed9270e120203a233a8828e910b50"></a>
|
|
virtual void </td><td class="memItemRight" valign="bottom"><b>setEndian</b> (Endian)=0</td></tr>
|
|
<tr class="separator:ac76ed9270e120203a233a8828e910b50"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0344f670303f82778c04f0206b160669"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0344f670303f82778c04f0206b160669"></a>
|
|
virtual Endian </td><td class="memItemRight" valign="bottom"><b>endian</b> () const =0</td></tr>
|
|
<tr class="separator:a0344f670303f82778c04f0206b160669"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8ab0b951701b2fd33a1d849967b2f201"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8ab0b951701b2fd33a1d849967b2f201"></a>
|
|
virtual bool </td><td class="memItemRight" valign="bottom"><b>isBigEndian</b> () const =0</td></tr>
|
|
<tr class="separator:a8ab0b951701b2fd33a1d849967b2f201"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa74c83f61471160c51d492ba5f8926b0"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa74c83f61471160c51d492ba5f8926b0"></a>
|
|
virtual bool </td><td class="memItemRight" valign="bottom"><b>isLittleEndian</b> () const =0</td></tr>
|
|
<tr class="separator:aa74c83f61471160c51d492ba5f8926b0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab26262d5ab77decae672efa85541e307"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab26262d5ab77decae672efa85541e307"></a>
|
|
virtual bool </td><td class="memItemRight" valign="bottom"><b>isOpen</b> () const =0</td></tr>
|
|
<tr class="separator:ab26262d5ab77decae672efa85541e307"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad1bad5dc5bd938645a6578ecf89bc572"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad1bad5dc5bd938645a6578ecf89bc572"></a>
|
|
virtual void </td><td class="memItemRight" valign="bottom"><b>seek</b> (atInt64, SeekOrigin)=0</td></tr>
|
|
<tr class="separator:ad1bad5dc5bd938645a6578ecf89bc572"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad8500312372d8604d4f3d555b85a1e53"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad8500312372d8604d4f3d555b85a1e53"></a>
|
|
virtual bool </td><td class="memItemRight" valign="bottom"><b>atEnd</b> () const =0</td></tr>
|
|
<tr class="separator:ad8500312372d8604d4f3d555b85a1e53"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1ba6eb3816856669630c031d24c1dc45"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1ba6eb3816856669630c031d24c1dc45"></a>
|
|
virtual atUint64 </td><td class="memItemRight" valign="bottom"><b>position</b> () const =0</td></tr>
|
|
<tr class="separator:a1ba6eb3816856669630c031d24c1dc45"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae89021cbb1ecaa01f0e5c8cb9275c865"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae89021cbb1ecaa01f0e5c8cb9275c865"></a>
|
|
virtual atUint64 </td><td class="memItemRight" valign="bottom"><b>length</b> () const =0</td></tr>
|
|
<tr class="separator:ae89021cbb1ecaa01f0e5c8cb9275c865"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6da3ceadb0fab2cb9d968b68f7705f2a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6da3ceadb0fab2cb9d968b68f7705f2a"></a>
|
|
virtual void </td><td class="memItemRight" valign="bottom"><b>seekBit</b> (int)=0</td></tr>
|
|
<tr class="separator:a6da3ceadb0fab2cb9d968b68f7705f2a"><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#l00028">28</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="class_athena_1_1io_1_1_i_stream.html">IStream</a></li>
|
|
<li class="footer">Generated on Thu May 21 2015 01:59:41 for Athena IO Library by
|
|
<a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.9.1 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|