| <!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="viewport" content="width=device-width, initial-scale=1"/> |
| <title>mxnet: dmlc::TemporaryDirectory 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="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" /> |
| </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 id="projectalign" style="padding-left: 0.5em;"> |
| <div id="projectname">mxnet |
| </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> |
| <!-- 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="namespacedmlc.html">dmlc</a></li><li class="navelem"><a class="el" href="classdmlc_1_1TemporaryDirectory.html">TemporaryDirectory</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="#pub-attribs">Public Attributes</a> | |
| <a href="classdmlc_1_1TemporaryDirectory-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">dmlc::TemporaryDirectory Class Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>Manager class for temporary directories. Whenever a new <a class="el" href="classdmlc_1_1TemporaryDirectory.html" title="Manager class for temporary directories. Whenever a new TemporaryDirectory object is constructed...">TemporaryDirectory</a> object is constructed, a temporary directory is created. The directory is deleted when the object is deleted or goes out of scope. Note: no symbolic links are allowed inside the temporary directory. |
| <a href="classdmlc_1_1TemporaryDirectory.html#details">More...</a></p> |
| |
| <p><code>#include <<a class="el" href="filesystem_8h_source.html">filesystem.h</a>></code></p> |
| <div class="dynheader"> |
| Collaboration diagram for dmlc::TemporaryDirectory:</div> |
| <div class="dyncontent"> |
| <div class="center"><img src="classdmlc_1_1TemporaryDirectory__coll__graph.png" border="0" usemap="#dmlc_1_1TemporaryDirectory_coll__map" alt="Collaboration graph"/></div> |
| <map name="dmlc_1_1TemporaryDirectory_coll__map" id="dmlc_1_1TemporaryDirectory_coll__map"> |
| </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:aba66f5c82ab2182af705417b566387e4"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1TemporaryDirectory.html#aba66f5c82ab2182af705417b566387e4">TemporaryDirectory</a> (bool verbose=false)</td></tr> |
| <tr class="memdesc:aba66f5c82ab2182af705417b566387e4"><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. Creates a new temporary directory with a unique name. <a href="#aba66f5c82ab2182af705417b566387e4">More...</a><br /></td></tr> |
| <tr class="separator:aba66f5c82ab2182af705417b566387e4"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a3e909dd51a3463d57580d4bf2da71f1e"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1TemporaryDirectory.html#a3e909dd51a3463d57580d4bf2da71f1e">~TemporaryDirectory</a> ()</td></tr> |
| <tr class="memdesc:a3e909dd51a3463d57580d4bf2da71f1e"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. Will perform recursive deletion via RecursiveDelete() <a href="#a3e909dd51a3463d57580d4bf2da71f1e">More...</a><br /></td></tr> |
| <tr class="separator:a3e909dd51a3463d57580d4bf2da71f1e"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a> |
| Public Attributes</h2></td></tr> |
| <tr class="memitem:a254cc8d6c4c1e35e6e0e01bf367d1522"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classdmlc_1_1TemporaryDirectory.html#a254cc8d6c4c1e35e6e0e01bf367d1522">path</a></td></tr> |
| <tr class="memdesc:a254cc8d6c4c1e35e6e0e01bf367d1522"><td class="mdescLeft"> </td><td class="mdescRight">Full path of the temporary directory. <a href="#a254cc8d6c4c1e35e6e0e01bf367d1522">More...</a><br /></td></tr> |
| <tr class="separator:a254cc8d6c4c1e35e6e0e01bf367d1522"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>Manager class for temporary directories. Whenever a new <a class="el" href="classdmlc_1_1TemporaryDirectory.html" title="Manager class for temporary directories. Whenever a new TemporaryDirectory object is constructed...">TemporaryDirectory</a> object is constructed, a temporary directory is created. The directory is deleted when the object is deleted or goes out of scope. Note: no symbolic links are allowed inside the temporary directory. </p> |
| <p>Usage example: </p><div class="fragment"><div class="line"><span class="keywordtype">void</span> foo() {</div><div class="line"> <a class="code" href="classdmlc_1_1TemporaryDirectory.html">dmlc::TemporaryDirectory</a> tempdir;</div><div class="line"> <span class="comment">// Create a file my_file.txt inside the temporary directory</span></div><div class="line"> std::ofstream of(tempdir.<a class="code" href="classdmlc_1_1TemporaryDirectory.html#a254cc8d6c4c1e35e6e0e01bf367d1522">path</a> + <span class="stringliteral">"/my_file.txt"</span>);</div><div class="line"> <span class="comment">// ... write to my_file.txt ...</span></div><div class="line"></div><div class="line"> <span class="comment">// ... use my_file.txt</span></div><div class="line"></div><div class="line"> <span class="comment">// When tempdir goes out of scope, the temporary directory is deleted</span></div><div class="line">}</div></div><!-- fragment --> </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> |
| <a id="aba66f5c82ab2182af705417b566387e4"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aba66f5c82ab2182af705417b566387e4">◆ </a></span>TemporaryDirectory()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">dmlc::TemporaryDirectory::TemporaryDirectory </td> |
| <td>(</td> |
| <td class="paramtype">bool </td> |
| <td class="paramname"><em>verbose</em> = <code>false</code></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">explicit</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Default constructor. Creates a new temporary directory with a unique name. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">verbose</td><td>whether to emit extra messages </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="a3e909dd51a3463d57580d4bf2da71f1e"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a3e909dd51a3463d57580d4bf2da71f1e">◆ </a></span>~TemporaryDirectory()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">dmlc::TemporaryDirectory::~TemporaryDirectory </td> |
| <td>(</td> |
| <td class="paramname"></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>Destructor. Will perform recursive deletion via RecursiveDelete() </p> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Data Documentation</h2> |
| <a id="a254cc8d6c4c1e35e6e0e01bf367d1522"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a254cc8d6c4c1e35e6e0e01bf367d1522">◆ </a></span>path</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">std::string dmlc::TemporaryDirectory::path</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Full path of the temporary directory. </p> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following file:<ul> |
| <li>/work/mxnet/3rdparty/dmlc-core/include/dmlc/<a class="el" href="filesystem_8h_source.html">filesystem.h</a></li> |
| </ul> |
| </div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated on Thu Jan 5 2023 00:58:43 for mxnet by  <a href="http://www.doxygen.org/index.html"> |
| <img class="footer" src="doxygen.png" alt="doxygen"/> |
| </a> 1.8.13 |
| </small></address> |
| </body> |
| </html> |
