236 lines
12 KiB
HTML
236 lines
12 KiB
HTML
<!DOCTYPE html>
|
|
<html>
|
|
<head>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0">
|
|
<title>etk Library</title>
|
|
<link rel="stylesheet" href="base.css">
|
|
</head>
|
|
<body>
|
|
<div class="navbar navbar-fixed-top">
|
|
<div class="container">
|
|
<h1>etk Library</h1>
|
|
<li>etk</li>
|
|
<ul>
|
|
<li><a href="etk__Archive.html">Archive</a></li>
|
|
<li><a href="etk__Archive__Content.html">Archive::Content</a></li>
|
|
<li><a href="etk__BaseNoise.html">BaseNoise</a></li>
|
|
<li><a href="etk__Buffer.html">Buffer</a></li>
|
|
<li><a href="etk__CCout.html">CCout</a></li>
|
|
<li><a href="etk__CEndl.html">CEndl</a></li>
|
|
<li><a href="etk__CStart.html">CStart</a></li>
|
|
<li><a href="etk__Color.html">Color</a></li>
|
|
<li><a href="etk__FSNode.html">FSNode</a></li>
|
|
<li><a href="etk__FSNodeRight.html">FSNodeRight</a></li>
|
|
<li><a href="etk__Hash.html">Hash</a></li>
|
|
<li><a href="etk__HashData.html">HashData</a></li>
|
|
<li><a href="etk__Matrix4.html">Matrix4</a></li>
|
|
<li><a href="etk__MessageFifo.html">MessageFifo</a></li>
|
|
<li><a href="etk__Mutex.html">Mutex</a></li>
|
|
<li><a href="etk__Noise.html">Noise</a></li>
|
|
<li><a href="etk__Plane.html">Plane</a></li>
|
|
<li><a href="etk__RegExp.html">RegExp</a></li>
|
|
<li><a href="etk__RegExpNode.html">RegExpNode</a></li>
|
|
<li><a href="etk__RegExpNodeBracket.html">RegExpNodeBracket</a></li>
|
|
<li><a href="etk__RegExpNodeDigit.html">RegExpNodeDigit</a></li>
|
|
<li><a href="etk__RegExpNodeDigitNot.html">RegExpNodeDigitNot</a></li>
|
|
<li><a href="etk__RegExpNodeDot.html">RegExpNodeDot</a></li>
|
|
<li><a href="etk__RegExpNodeEOL.html">RegExpNodeEOL</a></li>
|
|
<li><a href="etk__RegExpNodeLetter.html">RegExpNodeLetter</a></li>
|
|
<li><a href="etk__RegExpNodeLetterNot.html">RegExpNodeLetterNot</a></li>
|
|
<li><a href="etk__RegExpNodePThese.html">RegExpNodePThese</a></li>
|
|
<li><a href="etk__RegExpNodePTheseElem.html">RegExpNodePTheseElem</a></li>
|
|
<li><a href="etk__RegExpNodeSOL.html">RegExpNodeSOL</a></li>
|
|
<li><a href="etk__RegExpNodeValue.html">RegExpNodeValue</a></li>
|
|
<li><a href="etk__RegExpNodeWhiteSpace.html">RegExpNodeWhiteSpace</a></li>
|
|
<li><a href="etk__RegExpNodeWhiteSpaceNot.html">RegExpNodeWhiteSpaceNot</a></li>
|
|
<li><a href="etk__RegExpNodeWordChar.html">RegExpNodeWordChar</a></li>
|
|
<li><a href="etk__RegExpNodeWordCharNot.html">RegExpNodeWordCharNot</a></li>
|
|
<li><a href="etk__Semaphore.html">Semaphore</a></li>
|
|
<li><a href="etk__UChar.html">UChar</a></li>
|
|
<li><a href="etk__Vector2D.html">Vector2D</a></li>
|
|
<li><a href="etk__Vector3D.html">Vector3D</a></li>
|
|
<li><a href="etk__Vector4D.html">Vector4D</a></li>
|
|
<li><a href="etk__archive__Zip.html">archive::Zip</a></li>
|
|
<li><a href="etk__elementPos_ts.html">elementPos_ts</a></li>
|
|
</ul>
|
|
<li><a href="etk__FSNType.html">FSNType</a></li>
|
|
<li><a href="etk__logLevel.html">logLevel</a></li>
|
|
<li><a href="etk__regExpPrivateSection.html">regExpPrivateSection</a></li>
|
|
<li><a href="etk__seekNode.html">seekNode</a></li>
|
|
<li><a href="etk__typeNode.html">typeNode</a></li>
|
|
</ul>
|
|
<li>unicode</li>
|
|
<ul>
|
|
<li><a href="unicode__charset.html">charset</a></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="container" id="content">
|
|
<h1>Class: etk::Archive</h1>
|
|
<br/>
|
|
<h2>Synopsis:</h2>
|
|
<pre>
|
|
+ <a class="code-function" href="#Archive">Archive</a> (<span class="code-storage-keyword">const</span> <a href="http://www.cplusplus.com/reference/string/string/" class="code-type">std::string</a> & <span class="code-argument">_fileName</span>);<br>+ ~<a class="code-function" href="#Archive">Archive</a> (<span class="code-type">void</span>);<br>+ <span class="code-storage-keyword">const</span> <a href="http://www.cplusplus.com/reference/string/string/" class="code-type">std::string</a> & <a class="code-function" href="#getFileName">getFileName</a> (<span class="code-type">void</span>);<br>+ <span class="code-type">int32_t</span> <a class="code-function" href="#size">size</a> (<span class="code-type">void</span>);<br>+ <span class="code-storage-keyword">const</span> <a href="http://www.cplusplus.com/reference/string/string/" class="code-type">std::string</a> & <a class="code-function" href="#getName">getName</a> (<span class="code-type">int32_t</span> <span class="code-argument">_id</span>);<br>+ <span class="code-storage-keyword">const</span> Content & <a class="code-function" href="#getContent">getContent</a> (<span class="code-type">int32_t</span> <span class="code-argument">_id</span>);<br>+ <span class="code-storage-keyword">const</span> Content & <a class="code-function" href="#getContent">getContent</a> (<span class="code-storage-keyword">const</span> <a href="http://www.cplusplus.com/reference/string/string/" class="code-type">std::string</a> & <span class="code-argument">_key</span>);<br>+ <span class="code-type">bool</span> <a class="code-function" href="#exist">exist</a> (<span class="code-storage-keyword">const</span> <a href="http://www.cplusplus.com/reference/string/string/" class="code-type">std::string</a> & <span class="code-argument">_key</span>);<br>+ <span class="code-type">void</span> <a class="code-function" href="#open">open</a> (<span class="code-storage-keyword">const</span> <a href="http://www.cplusplus.com/reference/string/string/" class="code-type">std::string</a> & <span class="code-argument">_key</span>);<br>+ <span class="code-type">void</span> <a class="code-function" href="#close">close</a> (<span class="code-storage-keyword">const</span> <a href="http://www.cplusplus.com/reference/string/string/" class="code-type">std::string</a> & <span class="code-argument">_key</span>);<br>+ <span class="code-type">void</span> <a class="code-function" href="#display">display</a> (<span class="code-type">void</span>);<br>+ <span class="code-storage-keyword">static</span> Archive * <a class="code-function" href="#load">load</a> (<span class="code-storage-keyword">const</span> <a href="http://www.cplusplus.com/reference/string/string/" class="code-type">std::string</a> & <span class="code-argument">_fileName</span>);<br># <span class="code-type">void</span> <a class="code-function" href="#loadFile">loadFile</a> (<span class="code-type">int32_t</span> <span class="code-argument">_id</span>);<br></pre>
|
|
|
|
|
|
<h2>Object Hierarchy:</h2>
|
|
<pre>
|
|
<b>etk::Archive</b>
|
|
+--> <a href="etk__archive__Zip.html">etk::archive::Zip</a>
|
|
</pre>
|
|
<br/>
|
|
<h2>Detail:<h2>
|
|
<h3>etk::<a id="Archive">Archive</a> ()</h3>
|
|
|
|
<pre>
|
|
<span class="code-function">Archive</span>(<span class="code-storage-keyword">const</span> <a href="http://www.cplusplus.com/reference/string/string/" class="code-type">std::string</a> & <span class="code-argument">_fileName</span>);</pre>
|
|
<br/>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3>etk::~<a id="Archive">Archive</a> ()</h3>
|
|
|
|
<pre>
|
|
~<span class="code-function">Archive</span>(<span class="code-type">void</span>);</pre>
|
|
<br/>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3><a id="getFileName">getFileName</a> ()</h3>
|
|
|
|
<pre>
|
|
<span class="code-storage-keyword">const</span> <a href="http://www.cplusplus.com/reference/string/string/" class="code-type">std::string</a> & <span class="code-function">getFileName</span>(<span class="code-type">void</span>);</pre>
|
|
<br/>
|
|
Get the current file name.
|
|
<br/><ul>
|
|
<b>Return:</b> the requested file name.
|
|
<br/></ul>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3><a id="size">size</a> ()</h3>
|
|
|
|
<pre>
|
|
<span class="code-type">int32_t</span> <span class="code-function">size</span>(<span class="code-type">void</span>);</pre>
|
|
<br/>
|
|
Get the number of elements
|
|
<br/><ul>
|
|
<b>Return:</b> nb files in the archive
|
|
<br/></ul>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3><a id="getName">getName</a> ()</h3>
|
|
|
|
<pre>
|
|
<span class="code-storage-keyword">const</span> <a href="http://www.cplusplus.com/reference/string/string/" class="code-type">std::string</a> & <span class="code-function">getName</span>(<span class="code-type">int32_t</span> <span class="code-argument">_id</span>);</pre>
|
|
<br/>
|
|
Get the File name of the ID
|
|
<br/><ul>
|
|
<b>Parameter [input]:</b> <span class="code-argument">_id</span> id of the element (must be < Size())
|
|
<br/><b>Return:</b> FileName of the requested id
|
|
<br/></ul>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3><a id="getContent">getContent</a> ()</h3>
|
|
|
|
<pre>
|
|
<span class="code-storage-keyword">const</span> Content & <span class="code-function">getContent</span>(<span class="code-type">int32_t</span> <span class="code-argument">_id</span>);</pre>
|
|
<br/>
|
|
Get the File name of the ID
|
|
<br/><ul>
|
|
<b>Parameter [input]:</b> <span class="code-argument">_id</span> id of the element (must be < Size())
|
|
<br/><b>Return:</b> the archive content
|
|
<br/></ul>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3><a id="getContent">getContent</a> ()</h3>
|
|
|
|
<pre>
|
|
<span class="code-storage-keyword">const</span> Content & <span class="code-function">getContent</span>(<span class="code-storage-keyword">const</span> <a href="http://www.cplusplus.com/reference/string/string/" class="code-type">std::string</a> & <span class="code-argument">_key</span>);</pre>
|
|
<br/>
|
|
Get the File name of the ID
|
|
<br/><ul>
|
|
<b>Parameter [input]:</b> <span class="code-argument">_key</span> name of the file
|
|
<br/><b>Return:</b> FileName of the requested id
|
|
<br/></ul>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3><a id="exist">exist</a> ()</h3>
|
|
|
|
<pre>
|
|
<span class="code-type">bool</span> <span class="code-function">exist</span>(<span class="code-storage-keyword">const</span> <a href="http://www.cplusplus.com/reference/string/string/" class="code-type">std::string</a> & <span class="code-argument">_key</span>);</pre>
|
|
<br/>
|
|
Check if a file exist
|
|
<br/><ul>
|
|
<b>Parameter [input]:</b> <span class="code-argument">_key</span> Name of the file
|
|
<br/><b>Return:</b> true if the file is present
|
|
<br/></ul>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3><a id="open">open</a> ()</h3>
|
|
|
|
<pre>
|
|
<span class="code-type">void</span> <span class="code-function">open</span>(<span class="code-storage-keyword">const</span> <a href="http://www.cplusplus.com/reference/string/string/" class="code-type">std::string</a> & <span class="code-argument">_key</span>);</pre>
|
|
<br/>
|
|
Load the specific file in the memory
|
|
<br/><ul>
|
|
<b>Parameter [input]:</b> <span class="code-argument">_key</span> Name of the file
|
|
<br/></ul>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3><a id="close">close</a> ()</h3>
|
|
|
|
<pre>
|
|
<span class="code-type">void</span> <span class="code-function">close</span>(<span class="code-storage-keyword">const</span> <a href="http://www.cplusplus.com/reference/string/string/" class="code-type">std::string</a> & <span class="code-argument">_key</span>);</pre>
|
|
<br/>
|
|
Un-Load the specific file from the memory
|
|
<br/><ul>
|
|
<b>Parameter [input]:</b> <span class="code-argument">_key</span> Name of the file
|
|
<br/></ul>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3><a id="display">display</a> ()</h3>
|
|
|
|
<pre>
|
|
<span class="code-type">void</span> <span class="code-function">display</span>(<span class="code-type">void</span>);</pre>
|
|
<br/>
|
|
Display all Element in the archive
|
|
<br/><br/>
|
|
|
|
<hr/>
|
|
<h3>etk::<a id="load">load</a> ()</h3>
|
|
|
|
<pre>
|
|
<span class="code-storage-keyword">static</span> Archive * <span class="code-function">load</span>(<span class="code-storage-keyword">const</span> <a href="http://www.cplusplus.com/reference/string/string/" class="code-type">std::string</a> & <span class="code-argument">_fileName</span>);</pre>
|
|
<br/>
|
|
Load an Achive with a specific name.
|
|
<br/><ul>
|
|
<b>Parameter [input]:</b> <span class="code-argument">_fileName</span> File name of the specific archive.
|
|
<br/><b>Return:</b> A pointer an the specified archive, the user might delete it.
|
|
<br/></ul>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3><a id="loadFile">loadFile</a> ()</h3>
|
|
|
|
<pre>
|
|
<span class="code-type">void</span> <span class="code-function">loadFile</span>(<span class="code-type">int32_t</span> <span class="code-argument">_id</span>);</pre>
|
|
<br/>
|
|
Request the load in memory of the concerned file.
|
|
<br/><ul>
|
|
<b>Parameter [input]:</b> <span class="code-argument">_id</span> Id of the file to load.
|
|
<br/></ul>
|
|
<br/>
|
|
|
|
<hr/>
|
|
</div>
|
|
</body>
|
|
</html>
|