athena/docs/class_athena_1_1io_1_1_file_writer.html

247 lines
19 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::FileWriter 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_1io_1_1_file_writer.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> &#124;
<a href="class_athena_1_1io_1_1_file_writer-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Athena::io::FileWriter Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<div class="dynheader">
Inheritance diagram for Athena::io::FileWriter:</div>
<div class="dyncontent">
<div class="center"><img src="class_athena_1_1io_1_1_file_writer__inherit__graph.png" border="0" usemap="#_athena_1_1io_1_1_file_writer_inherit__map" alt="Inheritance graph"/></div>
<map name="_athena_1_1io_1_1_file_writer_inherit__map" id="_athena_1_1io_1_1_file_writer_inherit__map">
<area shape="rect" id="node2" 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="5,277,196,501"/><area shape="rect" id="node3" href="class_athena_1_1io_1_1_i_stream.html" title="{Athena::io::IStream\n||+ ~IStream()\l+ setEndian()\l+ endian()\l+ isBigEndian()\l+ isLittleEndian()\l+ isOpen()\l+ seek()\l+ atEnd()\l+ position()\l+ length()\l+ seekBit()\l}" alt="" coords="25,5,176,229"/></map>
</div>
<div class="dynheader">
Collaboration diagram for Athena::io::FileWriter:</div>
<div class="dyncontent">
<div class="center"><img src="class_athena_1_1io_1_1_file_writer__coll__graph.png" border="0" usemap="#_athena_1_1io_1_1_file_writer_coll__map" alt="Collaboration graph"/></div>
<map name="_athena_1_1io_1_1_file_writer_coll__map" id="_athena_1_1io_1_1_file_writer_coll__map">
<area shape="rect" id="node2" 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="5,277,196,501"/><area shape="rect" id="node3" href="class_athena_1_1io_1_1_i_stream.html" title="{Athena::io::IStream\n||+ ~IStream()\l+ setEndian()\l+ endian()\l+ isBigEndian()\l+ isLittleEndian()\l+ isOpen()\l+ seek()\l+ atEnd()\l+ position()\l+ length()\l+ seekBit()\l}" alt="" coords="25,5,176,229"/></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:a1074dc84dd439879f0470cca7ca63d3b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1074dc84dd439879f0470cca7ca63d3b"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>FileWriter</b> (const std::string &amp;filename, bool overwrite=true)</td></tr>
<tr class="separator:a1074dc84dd439879f0470cca7ca63d3b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aad434b6c345754580fffb957dbb4e03c"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aad434b6c345754580fffb957dbb4e03c"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>setEndian</b> (Endian endian)</td></tr>
<tr class="separator:aad434b6c345754580fffb957dbb4e03c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae90d8d9c585c9e11bd8b840ef448d2b1"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae90d8d9c585c9e11bd8b840ef448d2b1"></a>
Endian&#160;</td><td class="memItemRight" valign="bottom"><b>endian</b> () const </td></tr>
<tr class="separator:ae90d8d9c585c9e11bd8b840ef448d2b1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adae92d3deb3341e7896e99fdce840db2"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="adae92d3deb3341e7896e99fdce840db2"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>isBigEndian</b> () const </td></tr>
<tr class="separator:adae92d3deb3341e7896e99fdce840db2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a03e0bb23f1ed67969ab12411670e5339"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a03e0bb23f1ed67969ab12411670e5339"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>isLittleEndian</b> () const </td></tr>
<tr class="separator:a03e0bb23f1ed67969ab12411670e5339"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a71def8d72bc9b425314cd0c063ea6842"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a71def8d72bc9b425314cd0c063ea6842"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>open</b> (bool overwrite=true)</td></tr>
<tr class="separator:a71def8d72bc9b425314cd0c063ea6842"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae31ed5c17ef1db87d7f912709aa98581"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae31ed5c17ef1db87d7f912709aa98581"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>close</b> ()</td></tr>
<tr class="separator:ae31ed5c17ef1db87d7f912709aa98581"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1eba1a92f24ef51c41ef3b0c070c1df4"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1eba1a92f24ef51c41ef3b0c070c1df4"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>isOpen</b> () const </td></tr>
<tr class="separator:a1eba1a92f24ef51c41ef3b0c070c1df4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a21a5b35495f7038685de37eb64752fb3"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a21a5b35495f7038685de37eb64752fb3"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>seek</b> (atInt64 pos, SeekOrigin origin=SeekOrigin::Current)</td></tr>
<tr class="separator:a21a5b35495f7038685de37eb64752fb3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4db4ce08c85249269b53e3434e50287a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4db4ce08c85249269b53e3434e50287a"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>seekAlign32</b> ()</td></tr>
<tr class="separator:a4db4ce08c85249269b53e3434e50287a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae03578b771c138d4bff3da3e3719def7"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae03578b771c138d4bff3da3e3719def7"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>atEnd</b> () const </td></tr>
<tr class="separator:ae03578b771c138d4bff3da3e3719def7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad46339855a6e1c52c3a50edf3bd8ece7"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad46339855a6e1c52c3a50edf3bd8ece7"></a>
atUint64&#160;</td><td class="memItemRight" valign="bottom"><b>position</b> () const </td></tr>
<tr class="separator:ad46339855a6e1c52c3a50edf3bd8ece7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3924e4be57d1e2ea93d4e949ba5b1a7e"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3924e4be57d1e2ea93d4e949ba5b1a7e"></a>
atUint64&#160;</td><td class="memItemRight" valign="bottom"><b>length</b> () const </td></tr>
<tr class="separator:a3924e4be57d1e2ea93d4e949ba5b1a7e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a914aa902c8d8e774c441a755e10dcf3a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a914aa902c8d8e774c441a755e10dcf3a"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>writeBit</b> (bool val)</td></tr>
<tr class="separator:a914aa902c8d8e774c441a755e10dcf3a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2756d2aabb42218857d1ccf7aa7f5b83"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2756d2aabb42218857d1ccf7aa7f5b83"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>seekBit</b> (int bit)</td></tr>
<tr class="separator:a2756d2aabb42218857d1ccf7aa7f5b83"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a88244d10bd2b843d824a44cf9b71af1e"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a88244d10bd2b843d824a44cf9b71af1e"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>writeUByte</b> (atUint8 val)</td></tr>
<tr class="separator:a88244d10bd2b843d824a44cf9b71af1e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4169b3756aa8302e774db43f3ac8e311"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4169b3756aa8302e774db43f3ac8e311"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>writeByte</b> (atInt8 val)</td></tr>
<tr class="separator:a4169b3756aa8302e774db43f3ac8e311"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aedc3b6ab49bd03fc89f794b6adc94dc5"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aedc3b6ab49bd03fc89f794b6adc94dc5"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>writeUBytes</b> (atUint8 *data, atUint64 len)</td></tr>
<tr class="separator:aedc3b6ab49bd03fc89f794b6adc94dc5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa47f8bb59464dfe2f2bd7d062419b789"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa47f8bb59464dfe2f2bd7d062419b789"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>writeBytes</b> (atInt8 *data, atUint64 len)</td></tr>
<tr class="separator:aa47f8bb59464dfe2f2bd7d062419b789"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a227b7f2070b63c87dda8a044131153ff"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a227b7f2070b63c87dda8a044131153ff"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>writeUint16</b> (atUint16 val)</td></tr>
<tr class="separator:a227b7f2070b63c87dda8a044131153ff"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a19341a0346efc860f676925242fe0975"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a19341a0346efc860f676925242fe0975"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>writeInt16</b> (atInt16 val)</td></tr>
<tr class="separator:a19341a0346efc860f676925242fe0975"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a16236f0bb7d9b02af791b4ca5ef645ee"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a16236f0bb7d9b02af791b4ca5ef645ee"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>writeUint32</b> (atUint32 val)</td></tr>
<tr class="separator:a16236f0bb7d9b02af791b4ca5ef645ee"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaa8dad4c2b6fad53f4ce919979f53845"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aaa8dad4c2b6fad53f4ce919979f53845"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>writeInt32</b> (atInt32 val)</td></tr>
<tr class="separator:aaa8dad4c2b6fad53f4ce919979f53845"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab3197fa874af72130be9e18939639cb3"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab3197fa874af72130be9e18939639cb3"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>writeUint64</b> (atUint64 val)</td></tr>
<tr class="separator:ab3197fa874af72130be9e18939639cb3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a091e27ab176e21692c18ad7c60ab4019"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a091e27ab176e21692c18ad7c60ab4019"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>writeInt64</b> (atInt64 val)</td></tr>
<tr class="separator:a091e27ab176e21692c18ad7c60ab4019"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0e4b3877dda296e7c6a3b5420dd6c563"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0e4b3877dda296e7c6a3b5420dd6c563"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>writeDouble</b> (double val)</td></tr>
<tr class="separator:a0e4b3877dda296e7c6a3b5420dd6c563"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a013acaf6a8f55eeefb4c14b074cec43a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a013acaf6a8f55eeefb4c14b074cec43a"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>writeFloat</b> (float val)</td></tr>
<tr class="separator:a013acaf6a8f55eeefb4c14b074cec43a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6a353ba412e22e229acec4786d2ce5b7"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6a353ba412e22e229acec4786d2ce5b7"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>writeBool</b> (bool val)</td></tr>
<tr class="separator:a6a353ba412e22e229acec4786d2ce5b7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abb30184a1b51105e20c8c50cb3210e23"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abb30184a1b51105e20c8c50cb3210e23"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>writeString</b> (const std::string &amp;val)</td></tr>
<tr class="separator:abb30184a1b51105e20c8c50cb3210e23"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5ee481eff88e79624049037fa6736f14"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5ee481eff88e79624049037fa6736f14"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>writeUnicode</b> (const std::string &amp;str)</td></tr>
<tr class="separator:a5ee481eff88e79624049037fa6736f14"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac0e1f0095c11a9123fc08918f61b6532"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac0e1f0095c11a9123fc08918f61b6532"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>fill</b> (atInt8 byte, atUint64 len)</td></tr>
<tr class="separator:ac0e1f0095c11a9123fc08918f61b6532"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a95ac752da5cabff951f4984323d4d346"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a95ac752da5cabff951f4984323d4d346"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>fill</b> (atUint8 byte, atUint64 len)</td></tr>
<tr class="separator:a95ac752da5cabff951f4984323d4d346"><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>Definition at line <a class="el" href="_file_writer_8hpp_source.html#l00026">26</a> of file <a class="el" href="_file_writer_8hpp_source.html">FileWriter.hpp</a>.</p>
</div><hr/>The documentation for this class was generated from the following file:<ul>
<li>include/Athena/<a class="el" href="_file_writer_8hpp_source.html">FileWriter.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_file_writer.html">FileWriter</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>