581 lines
26 KiB
HTML
581 lines
26 KiB
HTML
<!-- HTML header for doxygen 1.8.8-->
|
|
<!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="X-UA-Compatible" content="IE=edge">
|
|
<!-- For Mobile Devices -->
|
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta name="generator" content="Doxygen 1.8.12"/>
|
|
<script type="text/javascript" src="https://code.jquery.com/jquery-2.1.1.min.js"></script>
|
|
<title>zeus: Zeus ewol micro-service interface: zeus::File Class Reference</title>
|
|
<!--<link href="tabs.css" rel="stylesheet" type="text/css"/>-->
|
|
<script type="text/javascript" src="dynsections.js"></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>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
<link href="customdoxygen.css" rel="stylesheet" type="text/css"/>
|
|
<link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.1/css/bootstrap.min.css">
|
|
<script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.1/js/bootstrap.min.js"></script>
|
|
<script type="text/javascript" src="doxy-boot.js"></script>
|
|
</head>
|
|
<body>
|
|
<nav class="navbar navbar-default navbar-fixed-top" role="navigation">
|
|
<div class="container">
|
|
<div class="navbar-header">
|
|
<a class="navbar-brand">zeus: Zeus ewol micro-service interface 0.4.0</a>
|
|
</div>
|
|
<div id="navbar" class="navbar-collapse collapse">
|
|
<ul class="nav navbar-nav">
|
|
<li><a href="index.html">Main Page</a></li>
|
|
<li><a href="pages.html">Related Pages</a></li>
|
|
<li><a href="namespaces.html">Namespaces</a></li>
|
|
<li><a href="annotated.html">Classes</a></li>
|
|
<li><a href="files.html">Files</a></li>
|
|
</ul>
|
|
<ul class="nav navbar-nav navbar-right">
|
|
<li class="dropdown">
|
|
<a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">
|
|
Link-libs<span class="caret"></span>
|
|
</a>
|
|
<ul class="dropdown-menu">
|
|
<li><a href="http://HeeroYui.github.io/lutin">lutin</a></li>
|
|
<li><a href="http://atria-soft.github.io/ewol">ewol</a></li>
|
|
<li><a href="http://atria-soft.github.io/echrono">echrono</a></li>
|
|
<li><a href="http://atria-soft.github.io/etk">etk</a></li>
|
|
<li><a href="http://atria-soft.github.io/ejson">ejson</a></li>
|
|
<li><a href="http://atria-soft.github.io/exml">exml</a></li>
|
|
<li><a href="http://atria-soft.github.io/esvg">esvg</a></li>
|
|
<li><a href="http://atria-soft.github.io/egami">egami</a></li>
|
|
<li><a href="http://atria-soft.github.io/gale">gale</a></li>
|
|
<li><a href="http://atria-soft.github.io/ege">ege</a></li>
|
|
<li><a href="http://atria-soft.github.io/elog">elog</a></li>
|
|
<li><a href="http://atria-soft.github.io/ememory">ememory</a></li>
|
|
<li><a href="http://atria-soft.github.io/enet">enet</a></li>
|
|
<li><a href="http://atria-soft.github.io/eproperty">eproperty</a></li>
|
|
<li><a href="http://atria-soft.github.io/esignal">esignal</a></li>
|
|
<li><a href="http://atria-soft.github.io/etranslate">etranslate</a></li>
|
|
<li><a href="http://atria-soft.github.io/zeus">zeus</a></li>
|
|
<li><a href="http://musicdsp.github.io/audio-ess">audio-ess</a></li>
|
|
<li><a href="http://musicdsp.github.io/audio">audio</a></li>
|
|
<li><a href="http://musicdsp.github.io/audio-drain">audio-drain</a></li>
|
|
<li><a href="http://musicdsp.github.io/audio-orchestra">audio-orchestra</a></li>
|
|
<li><a href="http://musicdsp.github.io/audio-river">audio-river</a></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<div id="search-box" class="input-group">
|
|
<div class="input-group-btn">
|
|
<button aria-expanded="false" type="button" class="btn btn-default dropdown-toggle" data-toggle="dropdown">
|
|
<span class="glyphicon glyphicon-search"></span>
|
|
<span class="caret"></span>
|
|
</button>
|
|
<ul class="dropdown-menu">
|
|
<li><a href="#">All</a></li>
|
|
<li><a href="#">Classes</a></li>
|
|
<li><a href="#">Namespaces</a></li>
|
|
<li><a href="#">Files</a></li>
|
|
<li><a href="#">Functions</a></li>
|
|
<li><a href="#">Variables</a></li>
|
|
<li><a href="#">Typedefs</a></li>
|
|
<li><a href="#">Enumerations</a></li>
|
|
<li><a href="#">Enumerator</a></li>
|
|
<li><a href="#">Friends</a></li>
|
|
<li><a href="#">Macros</a></li>
|
|
<li><a href="#">Pages</a></li>
|
|
</ul>
|
|
</div>
|
|
<button id="search-close" type="button" class="close" aria-label="Close">
|
|
<span aria-hidden="true"></span>
|
|
</button>
|
|
<input id="search-field" class="form-control" accesskey="S" onkeydown="searchBox.OnSearchFieldChange(event);" placeholder="Search ..." type="text">
|
|
</div>
|
|
</div><!--/.nav-collapse -->
|
|
</div>
|
|
</nav>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<div class="content" id="content">
|
|
<div class="container">
|
|
<div class="row">
|
|
<div class="col-sm-12 panel panel-default" style="padding-bottom: 15px;">
|
|
<div style="margin-bottom: 15px;margin-top: 60px;">
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.12 -->
|
|
<script type="text/javascript">
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
</script>
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search');
|
|
$(document).ready(function() { init_search(); });
|
|
});
|
|
</script>
|
|
<div id="main-nav"></div>
|
|
<!-- 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 id="nav-path" class="navpath">
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="namespacezeus.html">zeus</a></li><li class="navelem"><a class="el" href="classzeus_1_1_file.html">File</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="classzeus_1_1_file-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">zeus::File Class Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p><code>#include <<a class="el" href="_file_8hpp_source.html">File.hpp</a>></code></p>
|
|
<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:a347f4ee8c48496ad6ccf4905098cc1a3"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classzeus_1_1_file.html#a347f4ee8c48496ad6ccf4905098cc1a3">File</a> ()</td></tr>
|
|
<tr class="separator:a347f4ee8c48496ad6ccf4905098cc1a3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab2d06d23ca54e1579430fbcc2c0fe194"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classzeus_1_1_file.html#ab2d06d23ca54e1579430fbcc2c0fe194">File</a> (const std::string &_filename)</td></tr>
|
|
<tr class="separator:ab2d06d23ca54e1579430fbcc2c0fe194"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a139b49e9947c2531a06d8cc29f0ecaae"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classzeus_1_1_file.html#a139b49e9947c2531a06d8cc29f0ecaae">File</a> (const std::string &_mineType, std::vector< uint8_t > _data, int32_t _fileSize=-1)</td></tr>
|
|
<tr class="separator:a139b49e9947c2531a06d8cc29f0ecaae"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1ea2c1be180e45e85588cd08260ee646"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classzeus_1_1_file.html#a1ea2c1be180e45e85588cd08260ee646">File</a> (const std::string &_mineType, int32_t _size)</td></tr>
|
|
<tr class="separator:a1ea2c1be180e45e85588cd08260ee646"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab84dccb7817bb4c1024f6855f6c3299e"><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classzeus_1_1_file.html#ab84dccb7817bb4c1024f6855f6c3299e">getTheoricFileSize</a> () const</td></tr>
|
|
<tr class="separator:ab84dccb7817bb4c1024f6855f6c3299e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8f033107c62f94e85c5bc41565a09557"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classzeus_1_1_file.html#a8f033107c62f94e85c5bc41565a09557">storeIn</a> (const std::string &_filename) const</td></tr>
|
|
<tr class="separator:a8f033107c62f94e85c5bc41565a09557"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a15f115334e4b61f115bad019b2d96f73"><td class="memItemLeft" align="right" valign="top">const std::string & </td><td class="memItemRight" valign="bottom"><a class="el" href="classzeus_1_1_file.html#a15f115334e4b61f115bad019b2d96f73">getMineType</a> () const</td></tr>
|
|
<tr class="separator:a15f115334e4b61f115bad019b2d96f73"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a46b613bce19240b648d71258551cd4f9"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classzeus_1_1_file.html#a46b613bce19240b648d71258551cd4f9">setMineType</a> (const std::string &_type)</td></tr>
|
|
<tr class="separator:a46b613bce19240b648d71258551cd4f9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6962ed7df661f54967d1a5261766c92a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classzeus_1_1_file.html#a6962ed7df661f54967d1a5261766c92a">preSetDataSize</a> (uint64_t _size)</td></tr>
|
|
<tr class="separator:a6962ed7df661f54967d1a5261766c92a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4d483918b8752d2b2b7cc63959fae575"><td class="memItemLeft" align="right" valign="top">const std::vector< uint8_t > & </td><td class="memItemRight" valign="bottom"><a class="el" href="classzeus_1_1_file.html#a4d483918b8752d2b2b7cc63959fae575">getData</a> () const</td></tr>
|
|
<tr class="separator:a4d483918b8752d2b2b7cc63959fae575"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:afd274fe57fdd61d0573aa1433c1d5e58"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classzeus_1_1_file.html#afd274fe57fdd61d0573aa1433c1d5e58">setData</a> (uint64_t _offset, const std::vector< uint8_t > &_data)</td></tr>
|
|
<tr class="separator:afd274fe57fdd61d0573aa1433c1d5e58"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a96df0f6d8524da565eda3683c7bec5e9"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classzeus_1_1_file.html#a96df0f6d8524da565eda3683c7bec5e9">setData</a> (uint64_t _offset, const uint8_t *_data, uint32_t _size)</td></tr>
|
|
<tr class="separator:a96df0f6d8524da565eda3683c7bec5e9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p><a class="el" href="classzeus_1_1_file.html" title="File inetrface. ">File</a> inetrface. </p>
|
|
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a id="a347f4ee8c48496ad6ccf4905098cc1a3"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a347f4ee8c48496ad6ccf4905098cc1a3">§ </a></span>File() <span class="overload">[1/4]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">zeus::File::File </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Contructor of an empty file. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ab2d06d23ca54e1579430fbcc2c0fe194"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab2d06d23ca54e1579430fbcc2c0fe194">§ </a></span>File() <span class="overload">[2/4]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">zeus::File::File </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::string & </td>
|
|
<td class="paramname"><em>_filename</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Contructor with the name of a file (load all data) </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">_filename</td><td>path of the file </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a139b49e9947c2531a06d8cc29f0ecaae"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a139b49e9947c2531a06d8cc29f0ecaae">§ </a></span>File() <span class="overload">[3/4]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">zeus::File::File </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::string & </td>
|
|
<td class="paramname"><em>_mineType</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">std::vector< uint8_t > </td>
|
|
<td class="paramname"><em>_data</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int32_t </td>
|
|
<td class="paramname"><em>_fileSize</em> = <code>-1</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Constructor of a typed file. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">_mineType</td><td>mine type of the file </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">_data</td><td>data of the file </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">_fileSize</td><td>theoric file size </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a1ea2c1be180e45e85588cd08260ee646"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a1ea2c1be180e45e85588cd08260ee646">§ </a></span>File() <span class="overload">[4/4]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">zeus::File::File </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::string & </td>
|
|
<td class="paramname"><em>_mineType</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int32_t </td>
|
|
<td class="paramname"><em>_size</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Constructor of a typed file. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">_mineType</td><td>mine type of the file </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">_fileSize</td><td>preallocation size (data will be set after ...) </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="a4d483918b8752d2b2b7cc63959fae575"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4d483918b8752d2b2b7cc63959fae575">§ </a></span>getData()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const std::vector<uint8_t>& zeus::File::getData </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>get a rérérence of the data </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>requested data </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a15f115334e4b61f115bad019b2d96f73"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a15f115334e4b61f115bad019b2d96f73">§ </a></span>getMineType()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const std::string& zeus::File::getMineType </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get the mine type of the file. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>generic mine type </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ab84dccb7817bb4c1024f6855f6c3299e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab84dccb7817bb4c1024f6855f6c3299e">§ </a></span>getTheoricFileSize()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int32_t zeus::File::getTheoricFileSize </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>get the théoric file size </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>size of the file </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a6962ed7df661f54967d1a5261766c92a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a6962ed7df661f54967d1a5261766c92a">§ </a></span>preSetDataSize()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void zeus::File::preSetDataSize </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint64_t </td>
|
|
<td class="paramname"><em>_size</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>préallocate the data </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">_size</td><td>New size of the buffer </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="afd274fe57fdd61d0573aa1433c1d5e58"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#afd274fe57fdd61d0573aa1433c1d5e58">§ </a></span>setData() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void zeus::File::setData </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint64_t </td>
|
|
<td class="paramname"><em>_offset</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const std::vector< uint8_t > & </td>
|
|
<td class="paramname"><em>_data</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set data on the buffer. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">_offset</td><td>offset of the write data </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">_data</td><td>data to write </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a96df0f6d8524da565eda3683c7bec5e9"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a96df0f6d8524da565eda3683c7bec5e9">§ </a></span>setData() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void zeus::File::setData </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint64_t </td>
|
|
<td class="paramname"><em>_offset</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const uint8_t * </td>
|
|
<td class="paramname"><em>_data</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint32_t </td>
|
|
<td class="paramname"><em>_size</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set data on the buffer. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">_offset</td><td>offset of the write data </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">_data</td><td>pointer on the data to write </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">_size</td><td>Number of Octet to write </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a46b613bce19240b648d71258551cd4f9"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a46b613bce19240b648d71258551cd4f9">§ </a></span>setMineType()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void zeus::File::setMineType </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::string & </td>
|
|
<td class="paramname"><em>_type</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set the mine type of the file. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">_type</td><td>New type of the file </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a8f033107c62f94e85c5bc41565a09557"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a8f033107c62f94e85c5bc41565a09557">§ </a></span>storeIn()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void zeus::File::storeIn </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::string & </td>
|
|
<td class="paramname"><em>_filename</em></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Store data in the specify file. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">_filename</td><td>name of the file </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following file:<ul>
|
|
<li>framework/atria-soft/zeus/zeus/<a class="el" href="_file_8hpp_source.html">File.hpp</a></li>
|
|
</ul>
|
|
</div><!-- contents -->
|
|
<!-- HTML footer for doxygen 1.8.8-->
|
|
<!-- start footer part -->
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated on Mon Oct 24 2016 15:35:54 for zeus: Zeus ewol micro-service interface by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.12
|
|
</small></address>
|
|
</body>
|
|
</html>
|