1 <!-- HTML header for doxygen 1.8.9.1-->
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3 <html xmlns="http://www.w3.org/1999/xhtml">
5 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
6 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
7 <meta name="generator" content="Doxygen 1.8.11"/>
8 <meta name="robots" content="NOINDEX, NOFOLLOW" /> <!-- Prevent indexing by search engines -->
9 <title>Compute Library: FileHandler Class Reference</title>
10 <link href="tabs.css" rel="stylesheet" type="text/css"/>
11 <script type="text/javascript" src="jquery.js"></script>
12 <script type="text/javascript" src="dynsections.js"></script>
13 <link href="navtree.css" rel="stylesheet" type="text/css"/>
14 <script type="text/javascript" src="resize.js"></script>
15 <script type="text/javascript" src="navtreedata.js"></script>
16 <script type="text/javascript" src="navtree.js"></script>
17 <script type="text/javascript">
18 $(document).ready(initResizable);
19 $(window).load(resizeHeight);
21 <link href="search/search.css" rel="stylesheet" type="text/css"/>
22 <script type="text/javascript" src="search/searchdata.js"></script>
23 <script type="text/javascript" src="search/search.js"></script>
24 <script type="text/javascript">
25 $(document).ready(function() { init_search(); });
27 <script type="text/x-mathjax-config">
29 extensions: ["tex2jax.js"],
30 jax: ["input/TeX","output/HTML-CSS"],
32 </script><script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script>
33 <link href="doxygen.css" rel="stylesheet" type="text/css" />
36 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
38 <table cellspacing="0" cellpadding="0">
40 <tr style="height: 56px;">
41 <td style="padding-left: 0.5em;">
42 <div id="projectname">Compute Library
43  <span id="projectnumber">18.05</span>
50 <!-- end header part -->
51 <!-- Generated by Doxygen 1.8.11 -->
52 <script type="text/javascript">
53 var searchBox = new SearchBox("searchBox", "search",false,'Search');
55 <div id="navrow1" class="tabs">
57 <li><a href="index.xhtml"><span>Main Page</span></a></li>
58 <li><a href="pages.xhtml"><span>Related Pages</span></a></li>
59 <li><a href="namespaces.xhtml"><span>Namespaces</span></a></li>
60 <li class="current"><a href="annotated.xhtml"><span>Data Structures</span></a></li>
61 <li><a href="files.xhtml"><span>Files</span></a></li>
63 <div id="MSearchBox" class="MSearchBoxInactive">
65 <img id="MSearchSelect" src="search/mag_sel.png"
66 onmouseover="return searchBox.OnSearchSelectShow()"
67 onmouseout="return searchBox.OnSearchSelectHide()"
69 <input type="text" id="MSearchField" value="Search" accesskey="S"
70 onfocus="searchBox.OnSearchFieldFocus(true)"
71 onblur="searchBox.OnSearchFieldFocus(false)"
72 onkeyup="searchBox.OnSearchFieldChange(event)"/>
73 </span><span class="right">
74 <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
80 <div id="navrow2" class="tabs2">
82 <li><a href="annotated.xhtml"><span>Data Structures</span></a></li>
83 <li><a href="classes.xhtml"><span>Data Structure Index</span></a></li>
84 <li><a href="inherits.xhtml"><span>Class Hierarchy</span></a></li>
85 <li><a href="functions.xhtml"><span>Data Fields</span></a></li>
89 <div id="side-nav" class="ui-resizable side-nav-resizable">
91 <div id="nav-tree-contents">
92 <div id="nav-sync" class="sync"></div>
95 <div id="splitbar" style="-moz-user-select:none;"
96 class="ui-resizable-handle">
99 <script type="text/javascript">
100 $(document).ready(function(){initNavTree('classarm__compute_1_1io_1_1_file_handler.xhtml','');});
102 <div id="doc-content">
103 <!-- window showing the filter options -->
104 <div id="MSearchSelectWindow"
105 onmouseover="return searchBox.OnSearchSelectShow()"
106 onmouseout="return searchBox.OnSearchSelectHide()"
107 onkeydown="return searchBox.OnSearchSelectKey(event)">
110 <!-- iframe showing the search results (closed by default) -->
111 <div id="MSearchResultsWindow">
112 <iframe src="javascript:void(0)" frameborder="0"
113 name="MSearchResults" id="MSearchResults">
118 <div class="summary">
119 <a href="#pub-methods">Public Member Functions</a> </div>
120 <div class="headertitle">
121 <div class="title">FileHandler Class Reference</div> </div>
123 <div class="contents">
125 <p>File Handling interface.
126 <a href="classarm__compute_1_1io_1_1_file_handler.xhtml#details">More...</a></p>
128 <p><code>#include <<a class="el" href="_file_handler_8h_source.xhtml">FileHandler.h</a>></code></p>
129 <table class="memberdecls">
130 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
131 Public Member Functions</h2></td></tr>
132 <tr class="memitem:a7a105e8757c6bbbe0e6be820ce84f1ed"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1io_1_1_file_handler.xhtml#a7a105e8757c6bbbe0e6be820ce84f1ed">FileHandler</a> ()</td></tr>
133 <tr class="memdesc:a7a105e8757c6bbbe0e6be820ce84f1ed"><td class="mdescLeft"> </td><td class="mdescRight">Default Constructor. <a href="#a7a105e8757c6bbbe0e6be820ce84f1ed">More...</a><br /></td></tr>
134 <tr class="separator:a7a105e8757c6bbbe0e6be820ce84f1ed"><td class="memSeparator" colspan="2"> </td></tr>
135 <tr class="memitem:af21f1ebc53f4b79a0cda634bef0a6137"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1io_1_1_file_handler.xhtml#af21f1ebc53f4b79a0cda634bef0a6137">~FileHandler</a> ()</td></tr>
136 <tr class="memdesc:af21f1ebc53f4b79a0cda634bef0a6137"><td class="mdescLeft"> </td><td class="mdescRight">Default Destructor. <a href="#af21f1ebc53f4b79a0cda634bef0a6137">More...</a><br /></td></tr>
137 <tr class="separator:af21f1ebc53f4b79a0cda634bef0a6137"><td class="memSeparator" colspan="2"> </td></tr>
138 <tr class="memitem:ad5e81d7f7b3728303469466afa8909dd"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1io_1_1_file_handler.xhtml#ad5e81d7f7b3728303469466afa8909dd">FileHandler</a> (<a class="el" href="classarm__compute_1_1io_1_1_file_handler.xhtml">FileHandler</a> &&)=default</td></tr>
139 <tr class="memdesc:ad5e81d7f7b3728303469466afa8909dd"><td class="mdescLeft"> </td><td class="mdescRight">Allow instances of this class to be moved. <a href="#ad5e81d7f7b3728303469466afa8909dd">More...</a><br /></td></tr>
140 <tr class="separator:ad5e81d7f7b3728303469466afa8909dd"><td class="memSeparator" colspan="2"> </td></tr>
141 <tr class="memitem:a91b520f21421ff8fe1326635142276a9"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1io_1_1_file_handler.xhtml#a91b520f21421ff8fe1326635142276a9">FileHandler</a> (const <a class="el" href="classarm__compute_1_1io_1_1_file_handler.xhtml">FileHandler</a> &)=delete</td></tr>
142 <tr class="memdesc:a91b520f21421ff8fe1326635142276a9"><td class="mdescLeft"> </td><td class="mdescRight">Prevent instances of this class from being copied (As this class contains pointers) <a href="#a91b520f21421ff8fe1326635142276a9">More...</a><br /></td></tr>
143 <tr class="separator:a91b520f21421ff8fe1326635142276a9"><td class="memSeparator" colspan="2"> </td></tr>
144 <tr class="memitem:a9ffd691a00a5c9080528c3b852bda144"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarm__compute_1_1io_1_1_file_handler.xhtml">FileHandler</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1io_1_1_file_handler.xhtml#a9ffd691a00a5c9080528c3b852bda144">operator=</a> (const <a class="el" href="classarm__compute_1_1io_1_1_file_handler.xhtml">FileHandler</a> &)=delete</td></tr>
145 <tr class="memdesc:a9ffd691a00a5c9080528c3b852bda144"><td class="mdescLeft"> </td><td class="mdescRight">Prevent instances of this class from being copied (As this class contains pointers) <a href="#a9ffd691a00a5c9080528c3b852bda144">More...</a><br /></td></tr>
146 <tr class="separator:a9ffd691a00a5c9080528c3b852bda144"><td class="memSeparator" colspan="2"> </td></tr>
147 <tr class="memitem:a54f342231c056055100190a5429e4689"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarm__compute_1_1io_1_1_file_handler.xhtml">FileHandler</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1io_1_1_file_handler.xhtml#a54f342231c056055100190a5429e4689">operator=</a> (<a class="el" href="classarm__compute_1_1io_1_1_file_handler.xhtml">FileHandler</a> &&)=default</td></tr>
148 <tr class="memdesc:a54f342231c056055100190a5429e4689"><td class="mdescLeft"> </td><td class="mdescRight">Allow instances of this class to be moved. <a href="#a54f342231c056055100190a5429e4689">More...</a><br /></td></tr>
149 <tr class="separator:a54f342231c056055100190a5429e4689"><td class="memSeparator" colspan="2"> </td></tr>
150 <tr class="memitem:aa6d6ff37ab6cae622a54e37c16dd53b2"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1io_1_1_file_handler.xhtml#aa6d6ff37ab6cae622a54e37c16dd53b2">open</a> (const std::string &<a class="el" href="classarm__compute_1_1io_1_1_file_handler.xhtml#a16182afd0af6163476284de586c66c9d">filename</a>, std::ios_base::openmode mode)</td></tr>
151 <tr class="memdesc:aa6d6ff37ab6cae622a54e37c16dd53b2"><td class="mdescLeft"> </td><td class="mdescRight">Opens file. <a href="#aa6d6ff37ab6cae622a54e37c16dd53b2">More...</a><br /></td></tr>
152 <tr class="separator:aa6d6ff37ab6cae622a54e37c16dd53b2"><td class="memSeparator" colspan="2"> </td></tr>
153 <tr class="memitem:a5ae591df94fc66ccb85cbb6565368bca"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1io_1_1_file_handler.xhtml#a5ae591df94fc66ccb85cbb6565368bca">close</a> ()</td></tr>
154 <tr class="memdesc:a5ae591df94fc66ccb85cbb6565368bca"><td class="mdescLeft"> </td><td class="mdescRight">Closes file. <a href="#a5ae591df94fc66ccb85cbb6565368bca">More...</a><br /></td></tr>
155 <tr class="separator:a5ae591df94fc66ccb85cbb6565368bca"><td class="memSeparator" colspan="2"> </td></tr>
156 <tr class="memitem:a480926182a1f0b657c56803bc0122386"><td class="memItemLeft" align="right" valign="top">std::fstream & </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1io_1_1_file_handler.xhtml#a480926182a1f0b657c56803bc0122386">stream</a> ()</td></tr>
157 <tr class="memdesc:a480926182a1f0b657c56803bc0122386"><td class="mdescLeft"> </td><td class="mdescRight">Returns the file stream. <a href="#a480926182a1f0b657c56803bc0122386">More...</a><br /></td></tr>
158 <tr class="separator:a480926182a1f0b657c56803bc0122386"><td class="memSeparator" colspan="2"> </td></tr>
159 <tr class="memitem:a16182afd0af6163476284de586c66c9d"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1io_1_1_file_handler.xhtml#a16182afd0af6163476284de586c66c9d">filename</a> () const </td></tr>
160 <tr class="memdesc:a16182afd0af6163476284de586c66c9d"><td class="mdescLeft"> </td><td class="mdescRight">Returns filename of the handled file. <a href="#a16182afd0af6163476284de586c66c9d">More...</a><br /></td></tr>
161 <tr class="separator:a16182afd0af6163476284de586c66c9d"><td class="memSeparator" colspan="2"> </td></tr>
163 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
164 <div class="textblock"><p>File Handling interface. </p>
166 <p>Definition at line <a class="el" href="_file_handler_8h_source.xhtml#l00035">35</a> of file <a class="el" href="_file_handler_8h_source.xhtml">FileHandler.h</a>.</p>
167 </div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
168 <a class="anchor" id="a7a105e8757c6bbbe0e6be820ce84f1ed"></a>
169 <div class="memitem">
170 <div class="memproto">
171 <table class="memname">
173 <td class="memname"><a class="el" href="classarm__compute_1_1io_1_1_file_handler.xhtml">FileHandler</a> </td>
175 <td class="paramname"></td><td>)</td>
179 </div><div class="memdoc">
181 <p>Default Constructor. </p>
185 <a class="anchor" id="af21f1ebc53f4b79a0cda634bef0a6137"></a>
186 <div class="memitem">
187 <div class="memproto">
188 <table class="memname">
190 <td class="memname">~<a class="el" href="classarm__compute_1_1io_1_1_file_handler.xhtml">FileHandler</a> </td>
192 <td class="paramname"></td><td>)</td>
196 </div><div class="memdoc">
198 <p>Default Destructor. </p>
202 <a class="anchor" id="ad5e81d7f7b3728303469466afa8909dd"></a>
203 <div class="memitem">
204 <div class="memproto">
205 <table class="mlabels">
207 <td class="mlabels-left">
208 <table class="memname">
210 <td class="memname"><a class="el" href="classarm__compute_1_1io_1_1_file_handler.xhtml">FileHandler</a> </td>
212 <td class="paramtype"><a class="el" href="classarm__compute_1_1io_1_1_file_handler.xhtml">FileHandler</a> && </td>
213 <td class="paramname"></td><td>)</td>
218 <td class="mlabels-right">
219 <span class="mlabels"><span class="mlabel">default</span></span> </td>
222 </div><div class="memdoc">
224 <p>Allow instances of this class to be moved. </p>
228 <a class="anchor" id="a91b520f21421ff8fe1326635142276a9"></a>
229 <div class="memitem">
230 <div class="memproto">
231 <table class="mlabels">
233 <td class="mlabels-left">
234 <table class="memname">
236 <td class="memname"><a class="el" href="classarm__compute_1_1io_1_1_file_handler.xhtml">FileHandler</a> </td>
238 <td class="paramtype">const <a class="el" href="classarm__compute_1_1io_1_1_file_handler.xhtml">FileHandler</a> & </td>
239 <td class="paramname"></td><td>)</td>
244 <td class="mlabels-right">
245 <span class="mlabels"><span class="mlabel">delete</span></span> </td>
248 </div><div class="memdoc">
250 <p>Prevent instances of this class from being copied (As this class contains pointers) </p>
254 <h2 class="groupheader">Member Function Documentation</h2>
255 <a class="anchor" id="a5ae591df94fc66ccb85cbb6565368bca"></a>
256 <div class="memitem">
257 <div class="memproto">
258 <table class="memname">
260 <td class="memname">void close </td>
262 <td class="paramname"></td><td>)</td>
266 </div><div class="memdoc">
272 <a class="anchor" id="a16182afd0af6163476284de586c66c9d"></a>
273 <div class="memitem">
274 <div class="memproto">
275 <table class="memname">
277 <td class="memname">std::string filename </td>
279 <td class="paramname"></td><td>)</td>
283 </div><div class="memdoc">
285 <p>Returns filename of the handled file. </p>
286 <dl class="section return"><dt>Returns</dt><dd>File filename </dd></dl>
290 <a class="anchor" id="aa6d6ff37ab6cae622a54e37c16dd53b2"></a>
291 <div class="memitem">
292 <div class="memproto">
293 <table class="memname">
295 <td class="memname">void open </td>
297 <td class="paramtype">const std::string & </td>
298 <td class="paramname"><em>filename</em>, </td>
301 <td class="paramkey"></td>
303 <td class="paramtype">std::ios_base::openmode </td>
304 <td class="paramname"><em>mode</em> </td>
312 </div><div class="memdoc">
315 <dl class="params"><dt>Parameters</dt><dd>
316 <table class="params">
317 <tr><td class="paramdir">[in]</td><td class="paramname">filename</td><td>File name </td></tr>
318 <tr><td class="paramdir">[in]</td><td class="paramname">mode</td><td>File open mode </td></tr>
325 <a class="anchor" id="a9ffd691a00a5c9080528c3b852bda144"></a>
326 <div class="memitem">
327 <div class="memproto">
328 <table class="mlabels">
330 <td class="mlabels-left">
331 <table class="memname">
333 <td class="memname"><a class="el" href="classarm__compute_1_1io_1_1_file_handler.xhtml">FileHandler</a>& operator= </td>
335 <td class="paramtype">const <a class="el" href="classarm__compute_1_1io_1_1_file_handler.xhtml">FileHandler</a> & </td>
336 <td class="paramname"></td><td>)</td>
341 <td class="mlabels-right">
342 <span class="mlabels"><span class="mlabel">delete</span></span> </td>
345 </div><div class="memdoc">
347 <p>Prevent instances of this class from being copied (As this class contains pointers) </p>
351 <a class="anchor" id="a54f342231c056055100190a5429e4689"></a>
352 <div class="memitem">
353 <div class="memproto">
354 <table class="mlabels">
356 <td class="mlabels-left">
357 <table class="memname">
359 <td class="memname"><a class="el" href="classarm__compute_1_1io_1_1_file_handler.xhtml">FileHandler</a>& operator= </td>
361 <td class="paramtype"><a class="el" href="classarm__compute_1_1io_1_1_file_handler.xhtml">FileHandler</a> && </td>
362 <td class="paramname"></td><td>)</td>
367 <td class="mlabels-right">
368 <span class="mlabels"><span class="mlabel">default</span></span> </td>
371 </div><div class="memdoc">
373 <p>Allow instances of this class to be moved. </p>
377 <a class="anchor" id="a480926182a1f0b657c56803bc0122386"></a>
378 <div class="memitem">
379 <div class="memproto">
380 <table class="memname">
382 <td class="memname">std::fstream& stream </td>
384 <td class="paramname"></td><td>)</td>
388 </div><div class="memdoc">
390 <p>Returns the file stream. </p>
391 <dl class="section return"><dt>Returns</dt><dd>File stream </dd></dl>
395 <hr/>The documentation for this class was generated from the following file:<ul>
396 <li>arm_compute/core/utils/io/<a class="el" href="_file_handler_8h_source.xhtml">FileHandler.h</a></li>
398 </div><!-- contents -->
399 </div><!-- doc-content -->
400 <!-- start footer part -->
401 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
403 <li class="navelem"><a class="el" href="namespacearm__compute.xhtml">arm_compute</a></li><li class="navelem"><a class="el" href="namespacearm__compute_1_1io.xhtml">io</a></li><li class="navelem"><a class="el" href="classarm__compute_1_1io_1_1_file_handler.xhtml">FileHandler</a></li>
404 <li class="footer">Generated on Wed May 23 2018 11:36:43 for Compute Library by
405 <a href="http://www.doxygen.org/index.html">
406 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>