diff options
| author | Nikhil Raj <nikhil.raj@arm.com> | 2023-02-24 10:28:19 +0000 |
|---|---|---|
| committer | Nikhil Raj <nikhil.raj@arm.com> | 2023-02-24 10:28:19 +0000 |
| commit | 8d2ca734165a068478df7cffa46185680b05cd20 (patch) | |
| tree | 0433a7e6b007fe4639334c4438e58e9872a34b20 /23.02/namespacearmnn_utils_1_1_filesystem.xhtml | |
| parent | cb0630959aeae05bc2ae9f6d80cf5f5983a8fb77 (diff) | |
| download | armnn-8d2ca734165a068478df7cffa46185680b05cd20.tar.gz | |
Update Doxygen docu for 23.02
Signed-off-by: Nikhil Raj <nikhil.raj@arm.com>
Change-Id: Ie6c19a27d50fefab2796b2b5875374e81f5bf971
Diffstat (limited to '23.02/namespacearmnn_utils_1_1_filesystem.xhtml')
| -rw-r--r-- | 23.02/namespacearmnn_utils_1_1_filesystem.xhtml | 249 |
1 files changed, 249 insertions, 0 deletions
diff --git a/23.02/namespacearmnn_utils_1_1_filesystem.xhtml b/23.02/namespacearmnn_utils_1_1_filesystem.xhtml new file mode 100644 index 0000000000..4d23c52ca9 --- /dev/null +++ b/23.02/namespacearmnn_utils_1_1_filesystem.xhtml @@ -0,0 +1,249 @@ +<!-- Copyright (c) 2020 ARM Limited. --> +<!-- --> +<!-- SPDX-License-Identifier: MIT --> +<!-- --> +<!-- HTML header for doxygen 1.8.13--> +<!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.13"/> +<meta name="robots" content="NOINDEX, NOFOLLOW" /> +<meta name="viewport" content="width=device-width, initial-scale=1"/> +<title>ArmNN: armnnUtils::Filesystem Namespace 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); +</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/x-mathjax-config"> + MathJax.Hub.Config({ + extensions: ["tex2jax.js"], + jax: ["input/TeX","output/HTML-CSS"], +}); +</script><script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script> +<link href="doxygen.css" rel="stylesheet" type="text/css" /> +<link href="stylesheet.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;"> + <img alt="ArmNN" src="Arm_NN_horizontal_blue.png" style="max-width: 10rem; margin-top: .5rem; margin-left 10px"/> + <td style="padding-left: 0.5em;"> + <div id="projectname"> +  <span id="projectnumber">23.02</span> + </div> + </td> + </tr> + </tbody> +</table> +</div> +<!-- end header part --> +<!-- Generated by Doxygen 1.8.13 --> +<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> +</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('namespacearmnn_utils_1_1_filesystem.xhtml','');}); +</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="#typedef-members">Typedefs</a> | +<a href="#func-members">Functions</a> </div> + <div class="headertitle"> +<div class="title">armnnUtils::Filesystem Namespace Reference</div> </div> +</div><!--header--> +<div class="contents"> +<table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a> +Typedefs</h2></td></tr> +<tr class="memitem:ac43ab637ed192811c3b20c71990fd871"><td class="memItemLeft" align="right" valign="top">using </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacearmnn_utils_1_1_filesystem.xhtml#ac43ab637ed192811c3b20c71990fd871">FileContents</a> = std::string</td></tr> +<tr class="separator:ac43ab637ed192811c3b20c71990fd871"><td class="memSeparator" colspan="2"> </td></tr> +</table><table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> +Functions</h2></td></tr> +<tr class="memitem:a606d65835d72a332109c3c9f96a01b8a"><td class="memItemLeft" align="right" valign="top">fs::path </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacearmnn_utils_1_1_filesystem.xhtml#a606d65835d72a332109c3c9f96a01b8a">NamedTempFile</a> (const char *fileName)</td></tr> +<tr class="memdesc:a606d65835d72a332109c3c9f96a01b8a"><td class="mdescLeft"> </td><td class="mdescRight">Returns a path to a file in the system temporary folder. If the file existed it will be deleted. <a href="#a606d65835d72a332109c3c9f96a01b8a">More...</a><br /></td></tr> +<tr class="separator:a606d65835d72a332109c3c9f96a01b8a"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a0477efb2c6f5b41fbfe937fef6db312d"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacearmnn_utils_1_1_filesystem.xhtml#a0477efb2c6f5b41fbfe937fef6db312d">CreateDirectory</a> (std::string sPath)</td></tr> +<tr class="memdesc:a0477efb2c6f5b41fbfe937fef6db312d"><td class="mdescLeft"> </td><td class="mdescRight">Returns full path to temporary folder. <a href="#a0477efb2c6f5b41fbfe937fef6db312d">More...</a><br /></td></tr> +<tr class="separator:a0477efb2c6f5b41fbfe937fef6db312d"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a2bd6cbe2f39dd0507fb6ef5798e3bfe7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacearmnn_utils_1_1_filesystem.xhtml#ac43ab637ed192811c3b20c71990fd871">FileContents</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacearmnn_utils_1_1_filesystem.xhtml#a2bd6cbe2f39dd0507fb6ef5798e3bfe7">ReadFileContentsIntoString</a> (const std::string path)</td></tr> +<tr class="separator:a2bd6cbe2f39dd0507fb6ef5798e3bfe7"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<h2 class="groupheader">Typedef Documentation</h2> +<a id="ac43ab637ed192811c3b20c71990fd871"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ac43ab637ed192811c3b20c71990fd871">◆ </a></span>FileContents</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">using <a class="el" href="namespacearmnn_utils_1_1_filesystem.xhtml#ac43ab637ed192811c3b20c71990fd871">FileContents</a> = std::string</td> + </tr> + </table> +</div><div class="memdoc"> + +<p class="definition">Definition at line <a class="el" href="_filesystem_8hpp_source.xhtml#l00024">24</a> of file <a class="el" href="_filesystem_8hpp_source.xhtml">Filesystem.hpp</a>.</p> + +</div> +</div> +<h2 class="groupheader">Function Documentation</h2> +<a id="a0477efb2c6f5b41fbfe937fef6db312d"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a0477efb2c6f5b41fbfe937fef6db312d">◆ </a></span>CreateDirectory()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">std::string CreateDirectory </td> + <td>(</td> + <td class="paramtype">std::string </td> + <td class="paramname"><em>path</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Returns full path to temporary folder. </p> +<p>Construct a temporary directory.</p> +<p>Given a specified directory name construct a path in the system temporary directory. If the directory already exists, it is deleted, otherwise create it. This could throw filesystem_error exceptions.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">path</td><td>is the path required in the temporary directory. </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>path consisting of system temporary directory. </dd></dl> +<dl class="exception"><dt>Exceptions</dt><dd> + <table class="exception"> + <tr><td class="paramname">RuntimeException</td><td>if the directory cannot be created or exists but cannot be removed. </td></tr> + </table> + </dd> +</dl> + +<p class="definition">Definition at line <a class="el" href="_filesystem_8cpp_source.xhtml#l00047">47</a> of file <a class="el" href="_filesystem_8cpp_source.xhtml">Filesystem.cpp</a>.</p> + +<p class="reference">References <a class="el" href="namespacearmnn.xhtml#a4dc0adc6737b5944e7671bee71788407acb5e100e5a9a3e7f6d1fd97512215282">armnn::error</a>.</p> + +<p class="reference">Referenced by <a class="el" href="_network_8cpp_source.xhtml#l01572">armnn::Optimize()</a>.</p> +<div class="fragment"><div class="line"><a name="l00048"></a><span class="lineno"> 48</span> {</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <span class="comment">// This line is very unlikely to throw an exception.</span></div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  fs::path tmpDir = fs::temp_directory_path();</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  std::string full_path = tmpDir.generic_string() + path;</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <span class="keywordflow">if</span> (fs::exists(full_path))</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  {</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <span class="keywordflow">try</span></div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  {</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  <span class="comment">// This could throw an exception on a multi-user system.</span></div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  fs::remove_all(full_path);</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  }</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  <span class="keywordflow">catch</span> (<span class="keyword">const</span> std::system_error& e)</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  {</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  std::string <a class="code" href="namespacearmnn.xhtml#a4dc0adc6737b5944e7671bee71788407acb5e100e5a9a3e7f6d1fd97512215282">error</a> = <span class="stringliteral">"Directory exists and cannot be removed. Reason: "</span>;</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  error.append(e.what());</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  <span class="keywordflow">throw</span> <a class="code" href="classarmnn_1_1_runtime_exception.xhtml">armnn::RuntimeException</a>(error);</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  }</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  }</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="preprocessor">#if defined(_WIN32)</span></div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  result = _mkdir(full_path.c_str()); <span class="comment">// can be used on Windows</span></div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  armnn::ConditionalThrow<armnn::RuntimeException>((result == 0), <span class="stringliteral">"Was unable to create temporary directory"</span>);</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="preprocessor">#else</span></div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <span class="keywordflow">try</span></div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  {</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  <span class="keywordflow">if</span>(!fs::create_directory(full_path))</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  {</div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  <span class="keywordflow">throw</span> <a class="code" href="classarmnn_1_1_runtime_exception.xhtml">armnn::RuntimeException</a>(<span class="stringliteral">"Unable to create directory: "</span> + full_path);</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  }</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  }</div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  <span class="keywordflow">catch</span> (<span class="keyword">const</span> std::system_error& e)</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  {</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  std::string <a class="code" href="namespacearmnn.xhtml#a4dc0adc6737b5944e7671bee71788407acb5e100e5a9a3e7f6d1fd97512215282">error</a> = <span class="stringliteral">"Unable to create directory. Reason: "</span>;</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  error.append(e.what());</div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  <span class="keywordflow">throw</span> <a class="code" href="classarmnn_1_1_runtime_exception.xhtml">armnn::RuntimeException</a>(error);</div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  }</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span> </div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  <span class="keywordflow">return</span> full_path + <span class="stringliteral">"/"</span>;</div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span> }</div><div class="ttc" id="namespacearmnn_xhtml_a4dc0adc6737b5944e7671bee71788407acb5e100e5a9a3e7f6d1fd97512215282"><div class="ttname"><a href="namespacearmnn.xhtml#a4dc0adc6737b5944e7671bee71788407acb5e100e5a9a3e7f6d1fd97512215282">armnn::BoostLogSeverityMapping::error</a></div></div> +<div class="ttc" id="classarmnn_1_1_runtime_exception_xhtml"><div class="ttname"><a href="classarmnn_1_1_runtime_exception.xhtml">armnn::RuntimeException</a></div><div class="ttdef"><b>Definition:</b> <a href="_exceptions_8hpp_source.xhtml#l00120">Exceptions.hpp:120</a></div></div> +</div><!-- fragment --> +</div> +</div> +<a id="a606d65835d72a332109c3c9f96a01b8a"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a606d65835d72a332109c3c9f96a01b8a">◆ </a></span>NamedTempFile()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">fs::path NamedTempFile </td> + <td>(</td> + <td class="paramtype">const char * </td> + <td class="paramname"><em>fileName</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Returns a path to a file in the system temporary folder. If the file existed it will be deleted. </p> +<p>Construct a temporary file name.</p> +<p>Given a specified file name construct a path to that file in the system temporary directory. If the file already exists it is deleted. This could throw filesystem_error exceptions.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">fileName</td><td>the file name required in the temporary directory. </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>path consisting of system temporary directory and file name. </dd></dl> + +<p class="definition">Definition at line <a class="el" href="_filesystem_8cpp_source.xhtml#l00025">25</a> of file <a class="el" href="_filesystem_8cpp_source.xhtml">Filesystem.cpp</a>.</p> + +<p class="reference">Referenced by <a class="el" href="_j_s_o_n_timeline_decoder_tests_8cpp_source.xhtml#l00015">TEST_SUITE()</a>.</p> +<div class="fragment"><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> {</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  fs::path tmpDir = fs::temp_directory_path();</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  fs::path namedTempFile{tmpDir / fileName};</div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  <span class="keywordflow">if</span> (fs::exists(namedTempFile))</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  {</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  fs::remove(namedTempFile);</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  }</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  <span class="keywordflow">return</span> namedTempFile;</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> }</div></div><!-- fragment --> +</div> +</div> +<a id="a2bd6cbe2f39dd0507fb6ef5798e3bfe7"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a2bd6cbe2f39dd0507fb6ef5798e3bfe7">◆ </a></span>ReadFileContentsIntoString()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="namespacearmnn_utils_1_1_filesystem.xhtml#ac43ab637ed192811c3b20c71990fd871">FileContents</a> ReadFileContentsIntoString </td> + <td>(</td> + <td class="paramtype">const std::string </td> + <td class="paramname"><em>path</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p class="definition">Definition at line <a class="el" href="_filesystem_8cpp_source.xhtml#l00088">88</a> of file <a class="el" href="_filesystem_8cpp_source.xhtml">Filesystem.cpp</a>.</p> +<div class="fragment"><div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  {</div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  <span class="keywordflow">if</span> (!fs::exists(path))</div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  {</div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  <span class="keywordflow">throw</span> <a class="code" href="classarmnn_1_1_runtime_exception.xhtml">armnn::RuntimeException</a>(<span class="stringliteral">"Path does not exist: "</span> + path);</div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  }</div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  std::ifstream input_file(path);</div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  armnn::ConditionalThrow<armnn::RuntimeException>((input_file.is_open()), <span class="stringliteral">"Could not read file contents"</span>);</div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  <span class="keywordflow">return</span> <a class="code" href="namespacearmnn_utils_1_1_filesystem.xhtml#ac43ab637ed192811c3b20c71990fd871">FileContents</a>((std::istreambuf_iterator<char>(input_file)), std::istreambuf_iterator<char>());</div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span> }</div><div class="ttc" id="namespacearmnn_utils_1_1_filesystem_xhtml_ac43ab637ed192811c3b20c71990fd871"><div class="ttname"><a href="namespacearmnn_utils_1_1_filesystem.xhtml#ac43ab637ed192811c3b20c71990fd871">armnnUtils::Filesystem::FileContents</a></div><div class="ttdeci">std::string FileContents</div><div class="ttdef"><b>Definition:</b> <a href="_filesystem_8hpp_source.xhtml#l00024">Filesystem.hpp:24</a></div></div> +<div class="ttc" id="classarmnn_1_1_runtime_exception_xhtml"><div class="ttname"><a href="classarmnn_1_1_runtime_exception.xhtml">armnn::RuntimeException</a></div><div class="ttdef"><b>Definition:</b> <a href="_exceptions_8hpp_source.xhtml#l00120">Exceptions.hpp:120</a></div></div> +</div><!-- fragment --> +</div> +</div> +</div><!-- contents --> +</div><!-- doc-content --> +<!-- start footer part --> +<div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> + <ul> + <li class="navelem"><a class="el" href="namespacearmnn_utils.xhtml">armnnUtils</a></li><li class="navelem"><a class="el" href="namespacearmnn_utils_1_1_filesystem.xhtml">Filesystem</a></li> + <li class="footer">Generated on Fri Feb 24 2023 10:24:34 for ArmNN by + <a href="http://www.doxygen.org/index.html"> + <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li> + </ul> +</div> +</body> +</html> |