athena/docs/class_athena_1_1_wii_save.html

300 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.9.1"/>
<title>Athena IO Library: Athena::WiiSave 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&#160;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&#160;List</span></a></li>
<li><a href="classes.html"><span>Class&#160;Index</span></a></li>
<li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&#160;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_1_wii_save.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-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="class_athena_1_1_wii_save-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Athena::WiiSave Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Wii data.bin container class.
<a href="class_athena_1_1_wii_save.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="_wii_save_8hpp_source.html">WiiSave.hpp</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for Athena::WiiSave:</div>
<div class="dyncontent">
<div class="center"><img src="class_athena_1_1_wii_save__coll__graph.png" border="0" usemap="#_athena_1_1_wii_save_coll__map" alt="Collaboration graph"/></div>
</div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:aea23fdf6b851d29a8fb81bf8c647ebbb"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aea23fdf6b851d29a8fb81bf8c647ebbb"></a>
typedef std::unordered_map&lt; std::string, <a class="el" href="class_athena_1_1_wii_file.html">WiiFile</a> * &gt;::const_iterator&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_athena_1_1_wii_save.html#aea23fdf6b851d29a8fb81bf8c647ebbb">FileIterator</a></td></tr>
<tr class="memdesc:aea23fdf6b851d29a8fb81bf8c647ebbb"><td class="mdescLeft">&#160;</td><td class="mdescRight">FileIterator. <br /></td></tr>
<tr class="separator:aea23fdf6b851d29a8fb81bf8c647ebbb"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><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:a2158f541c1749f619a37859af6eadf47"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2158f541c1749f619a37859af6eadf47"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_athena_1_1_wii_save.html#a2158f541c1749f619a37859af6eadf47">WiiSave</a> ()</td></tr>
<tr class="memdesc:a2158f541c1749f619a37859af6eadf47"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="class_athena_1_1_wii_save.html" title="Wii data.bin container class. ">WiiSave</a>. <br /></td></tr>
<tr class="separator:a2158f541c1749f619a37859af6eadf47"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a740b8443a71e0307c41e9e100ac25ed7"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a740b8443a71e0307c41e9e100ac25ed7"></a>
virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_athena_1_1_wii_save.html#a740b8443a71e0307c41e9e100ac25ed7">~WiiSave</a> ()</td></tr>
<tr class="memdesc:a740b8443a71e0307c41e9e100ac25ed7"><td class="mdescLeft">&#160;</td><td class="mdescRight">~WiiSave <br /></td></tr>
<tr class="separator:a740b8443a71e0307c41e9e100ac25ed7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a59b713a72559b0a100bc52b0f12c014f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_athena_1_1_wii_save.html#a59b713a72559b0a100bc52b0f12c014f">addFile</a> (<a class="el" href="class_athena_1_1_wii_file.html">WiiFile</a> *<a class="el" href="class_athena_1_1_wii_save.html#a3c37a9b38bf207d93f87ca81874b4e05">file</a>)</td></tr>
<tr class="memdesc:a59b713a72559b0a100bc52b0f12c014f"><td class="mdescLeft">&#160;</td><td class="mdescRight">addFile <a href="#a59b713a72559b0a100bc52b0f12c014f">More...</a><br /></td></tr>
<tr class="separator:a59b713a72559b0a100bc52b0f12c014f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9f6412c94d6302bea3c890a104a5e52b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9f6412c94d6302bea3c890a104a5e52b"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>setRoot</b> (<a class="el" href="class_athena_1_1_wii_file.html">WiiFile</a> *<a class="el" href="class_athena_1_1_wii_save.html#ac427c39ec1d18298a1cfa02c6150a700">root</a>)</td></tr>
<tr class="separator:a9f6412c94d6302bea3c890a104a5e52b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3c37a9b38bf207d93f87ca81874b4e05"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_athena_1_1_wii_file.html">WiiFile</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_athena_1_1_wii_save.html#a3c37a9b38bf207d93f87ca81874b4e05">file</a> (const std::string &amp;filename)</td></tr>
<tr class="memdesc:a3c37a9b38bf207d93f87ca81874b4e05"><td class="mdescLeft">&#160;</td><td class="mdescRight">file <a href="#a3c37a9b38bf207d93f87ca81874b4e05">More...</a><br /></td></tr>
<tr class="separator:a3c37a9b38bf207d93f87ca81874b4e05"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8dab6d5e89f95d343a278c0046a18a82"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8dab6d5e89f95d343a278c0046a18a82"></a>
atUint32&#160;</td><td class="memItemRight" valign="bottom"><b>fileCount</b> () const </td></tr>
<tr class="separator:a8dab6d5e89f95d343a278c0046a18a82"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac427c39ec1d18298a1cfa02c6150a700"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_athena_1_1_wii_file.html">WiiFile</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_athena_1_1_wii_save.html#ac427c39ec1d18298a1cfa02c6150a700">root</a> ()</td></tr>
<tr class="memdesc:ac427c39ec1d18298a1cfa02c6150a700"><td class="mdescLeft">&#160;</td><td class="mdescRight">fileList <a href="#ac427c39ec1d18298a1cfa02c6150a700">More...</a><br /></td></tr>
<tr class="separator:ac427c39ec1d18298a1cfa02c6150a700"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afcfd02a55c7846e859f706e1378eedbd"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_athena_1_1_wii_save.html#afcfd02a55c7846e859f706e1378eedbd">setBanner</a> (<a class="el" href="class_athena_1_1_wii_banner.html">WiiBanner</a> *<a class="el" href="class_athena_1_1_wii_save.html#a7a10a9d75c6d1f12298939b2e679fa24">banner</a>)</td></tr>
<tr class="memdesc:afcfd02a55c7846e859f706e1378eedbd"><td class="mdescLeft">&#160;</td><td class="mdescRight">setBanner <a href="#afcfd02a55c7846e859f706e1378eedbd">More...</a><br /></td></tr>
<tr class="separator:afcfd02a55c7846e859f706e1378eedbd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7a10a9d75c6d1f12298939b2e679fa24"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_athena_1_1_wii_banner.html">WiiBanner</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_athena_1_1_wii_save.html#a7a10a9d75c6d1f12298939b2e679fa24">banner</a> () const </td></tr>
<tr class="memdesc:a7a10a9d75c6d1f12298939b2e679fa24"><td class="mdescLeft">&#160;</td><td class="mdescRight">banner <a href="#a7a10a9d75c6d1f12298939b2e679fa24">More...</a><br /></td></tr>
<tr class="separator:a7a10a9d75c6d1f12298939b2e679fa24"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a13e8315dd85ac890fd1b456da2c6651c"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a13e8315dd85ac890fd1b456da2c6651c"></a>
std::vector&lt; <a class="el" href="class_athena_1_1_wii_file.html">WiiFile</a> * &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>allFiles</b> () const </td></tr>
<tr class="separator:a13e8315dd85ac890fd1b456da2c6651c"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Wii data.bin container class. </p>
<p>Contains all relevant data for a Wii data.bin file. </p>
<p>Definition at line <a class="el" href="_wii_save_8hpp_source.html#l00038">38</a> of file <a class="el" href="_wii_save_8hpp_source.html">WiiSave.hpp</a>.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a59b713a72559b0a100bc52b0f12c014f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Athena::WiiSave::addFile </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_athena_1_1_wii_file.html">WiiFile</a> *&#160;</td>
<td class="paramname"><em>file</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>addFile </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">filename</td><td></td></tr>
<tr><td class="paramname">file</td><td></td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a7a10a9d75c6d1f12298939b2e679fa24"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_athena_1_1_wii_banner.html">WiiBanner</a>* Athena::WiiSave::banner </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>banner </p>
<dl class="section return"><dt>Returns</dt><dd></dd></dl>
</div>
</div>
<a class="anchor" id="a3c37a9b38bf207d93f87ca81874b4e05"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_athena_1_1_wii_file.html">WiiFile</a>* Athena::WiiSave::file </td>
<td>(</td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>filename</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>file </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">filename</td><td></td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd></dd></dl>
</div>
</div>
<a class="anchor" id="ac427c39ec1d18298a1cfa02c6150a700"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_athena_1_1_wii_file.html">WiiFile</a>* Athena::WiiSave::root </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>fileList </p>
<dl class="section return"><dt>Returns</dt><dd></dd></dl>
</div>
</div>
<a class="anchor" id="afcfd02a55c7846e859f706e1378eedbd"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Athena::WiiSave::setBanner </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_athena_1_1_wii_banner.html">WiiBanner</a> *&#160;</td>
<td class="paramname"><em>banner</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>setBanner </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">banner</td><td></td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>include/Athena/<a class="el" href="_wii_save_8hpp_source.html">WiiSave.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"><a class="el" href="class_athena_1_1_wii_save.html">WiiSave</a></li>
<li class="footer">Generated on Thu May 21 2015 01:59:40 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>