classutil_1_1FileIO.html 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  6. <meta name="generator" content="Doxygen 1.8.12"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>Tracore: util::FileIO Class Reference</title>
  9. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  10. <script type="text/javascript" src="jquery.js"></script>
  11. <script type="text/javascript" src="dynsections.js"></script>
  12. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  13. <script type="text/javascript" src="search/searchdata.js"></script>
  14. <script type="text/javascript" src="search/search.js"></script>
  15. <script type="text/javascript">
  16. $(document).ready(function() { init_search(); });
  17. </script>
  18. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  19. </head>
  20. <body>
  21. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  22. <div id="titlearea">
  23. <table cellspacing="0" cellpadding="0">
  24. <tbody>
  25. <tr style="height: 56px;">
  26. <td id="projectalign" style="padding-left: 0.5em;">
  27. <div id="projectname">Tracore
  28. </div>
  29. </td>
  30. </tr>
  31. </tbody>
  32. </table>
  33. </div>
  34. <!-- end header part -->
  35. <!-- Generated by Doxygen 1.8.12 -->
  36. <script type="text/javascript">
  37. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  38. </script>
  39. <div id="navrow1" class="tabs">
  40. <ul class="tablist">
  41. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  42. <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
  43. <li><a href="files.html"><span>Files</span></a></li>
  44. <li>
  45. <div id="MSearchBox" class="MSearchBoxInactive">
  46. <span class="left">
  47. <img id="MSearchSelect" src="search/mag_sel.png"
  48. onmouseover="return searchBox.OnSearchSelectShow()"
  49. onmouseout="return searchBox.OnSearchSelectHide()"
  50. alt=""/>
  51. <input type="text" id="MSearchField" value="Search" accesskey="S"
  52. onfocus="searchBox.OnSearchFieldFocus(true)"
  53. onblur="searchBox.OnSearchFieldFocus(false)"
  54. onkeyup="searchBox.OnSearchFieldChange(event)"/>
  55. </span><span class="right">
  56. <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  57. </span>
  58. </div>
  59. </li>
  60. </ul>
  61. </div>
  62. <div id="navrow2" class="tabs2">
  63. <ul class="tablist">
  64. <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
  65. <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
  66. <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
  67. <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
  68. </ul>
  69. </div>
  70. <!-- window showing the filter options -->
  71. <div id="MSearchSelectWindow"
  72. onmouseover="return searchBox.OnSearchSelectShow()"
  73. onmouseout="return searchBox.OnSearchSelectHide()"
  74. onkeydown="return searchBox.OnSearchSelectKey(event)">
  75. </div>
  76. <!-- iframe showing the search results (closed by default) -->
  77. <div id="MSearchResultsWindow">
  78. <iframe src="javascript:void(0)" frameborder="0"
  79. name="MSearchResults" id="MSearchResults">
  80. </iframe>
  81. </div>
  82. <div id="nav-path" class="navpath">
  83. <ul>
  84. <li class="navelem"><b>util</b></li><li class="navelem"><a class="el" href="classutil_1_1FileIO.html">FileIO</a></li> </ul>
  85. </div>
  86. </div><!-- top -->
  87. <div class="header">
  88. <div class="summary">
  89. <a href="#pub-static-methods">Static Public Member Functions</a> &#124;
  90. <a href="classutil_1_1FileIO-members.html">List of all members</a> </div>
  91. <div class="headertitle">
  92. <div class="title">util::FileIO Class Reference</div> </div>
  93. </div><!--header-->
  94. <div class="contents">
  95. <p><code>#include &lt;<a class="el" href="FileIO_8h_source.html">FileIO.h</a>&gt;</code></p>
  96. <table class="memberdecls">
  97. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
  98. Static Public Member Functions</h2></td></tr>
  99. <tr class="memitem:af42c183525923014e142a10a626d3677"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classutil_1_1FileIO.html#af42c183525923014e142a10a626d3677">ReadCSV</a> (Vector3d &amp;values, const std::string &amp;filename, char delimiter=';')</td></tr>
  100. <tr class="separator:af42c183525923014e142a10a626d3677"><td class="memSeparator" colspan="2">&#160;</td></tr>
  101. <tr class="memitem:a264c9b694fd7218635c8a783956d2c1e"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classutil_1_1FileIO.html#a264c9b694fd7218635c8a783956d2c1e">ReadCSV</a> (Vector2d &amp;values, const std::string &amp;filename, char delimiter=';')</td></tr>
  102. <tr class="separator:a264c9b694fd7218635c8a783956d2c1e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  103. <tr class="memitem:a6e290e22083d49619b757bfca96a51fa"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classutil_1_1FileIO.html#a6e290e22083d49619b757bfca96a51fa">ListFiles</a> (const std::string &amp;folder, std::vector&lt; std::string &gt; &amp;file_names, bool sort=true)</td></tr>
  104. <tr class="separator:a6e290e22083d49619b757bfca96a51fa"><td class="memSeparator" colspan="2">&#160;</td></tr>
  105. <tr class="memitem:a862586aced240e732ecd35773b57c267"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classutil_1_1FileIO.html#a862586aced240e732ecd35773b57c267">WriteCSVMatlab</a> (DirectedGraph &amp;graph, const std::string &amp;file_name, char delimiter=';')</td></tr>
  106. <tr class="separator:a862586aced240e732ecd35773b57c267"><td class="memSeparator" colspan="2">&#160;</td></tr>
  107. </table>
  108. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  109. <div class="textblock"><p>Utility class for file in- and output. </p>
  110. </div><h2 class="groupheader">Member Function Documentation</h2>
  111. <a class="anchor" id="a6e290e22083d49619b757bfca96a51fa"></a>
  112. <div class="memitem">
  113. <div class="memproto">
  114. <table class="mlabels">
  115. <tr>
  116. <td class="mlabels-left">
  117. <table class="memname">
  118. <tr>
  119. <td class="memname">void util::FileIO::ListFiles </td>
  120. <td>(</td>
  121. <td class="paramtype">const std::string &amp;&#160;</td>
  122. <td class="paramname"><em>folder</em>, </td>
  123. </tr>
  124. <tr>
  125. <td class="paramkey"></td>
  126. <td></td>
  127. <td class="paramtype">std::vector&lt; std::string &gt; &amp;&#160;</td>
  128. <td class="paramname"><em>file_names</em>, </td>
  129. </tr>
  130. <tr>
  131. <td class="paramkey"></td>
  132. <td></td>
  133. <td class="paramtype">bool&#160;</td>
  134. <td class="paramname"><em>sort</em> = <code>true</code>&#160;</td>
  135. </tr>
  136. <tr>
  137. <td></td>
  138. <td>)</td>
  139. <td></td><td></td>
  140. </tr>
  141. </table>
  142. </td>
  143. <td class="mlabels-right">
  144. <span class="mlabels"><span class="mlabel">static</span></span> </td>
  145. </tr>
  146. </table>
  147. </div><div class="memdoc">
  148. <p>Lists all file names in the given folder. </p><dl class="params"><dt>Parameters</dt><dd>
  149. <table class="params">
  150. <tr><td class="paramname">folder</td><td>The folder to look into </td></tr>
  151. <tr><td class="paramname">file_names</td><td>The vector to store the file names into </td></tr>
  152. <tr><td class="paramname">sort</td><td>True, if the files should be sorted alphabetically </td></tr>
  153. </table>
  154. </dd>
  155. </dl>
  156. </div>
  157. </div>
  158. <a class="anchor" id="af42c183525923014e142a10a626d3677"></a>
  159. <div class="memitem">
  160. <div class="memproto">
  161. <table class="mlabels">
  162. <tr>
  163. <td class="mlabels-left">
  164. <table class="memname">
  165. <tr>
  166. <td class="memname">void util::FileIO::ReadCSV </td>
  167. <td>(</td>
  168. <td class="paramtype">Vector3d &amp;&#160;</td>
  169. <td class="paramname"><em>values</em>, </td>
  170. </tr>
  171. <tr>
  172. <td class="paramkey"></td>
  173. <td></td>
  174. <td class="paramtype">const std::string &amp;&#160;</td>
  175. <td class="paramname"><em>filename</em>, </td>
  176. </tr>
  177. <tr>
  178. <td class="paramkey"></td>
  179. <td></td>
  180. <td class="paramtype">char&#160;</td>
  181. <td class="paramname"><em>delimiter</em> = <code>';'</code>&#160;</td>
  182. </tr>
  183. <tr>
  184. <td></td>
  185. <td>)</td>
  186. <td></td><td></td>
  187. </tr>
  188. </table>
  189. </td>
  190. <td class="mlabels-right">
  191. <span class="mlabels"><span class="mlabel">static</span></span> </td>
  192. </tr>
  193. </table>
  194. </div><div class="memdoc">
  195. <p>Reads a CSV file and stores the values in a 3D array. The first dimension is the first value of each row, used as a index to bundle multiple rows with the same first value into a single vector. The second dimension is the row in the row bundle. The third dimension is the value in that row. </p><dl class="params"><dt>Parameters</dt><dd>
  196. <table class="params">
  197. <tr><td class="paramname">values</td><td>The 3D array of values to store the read values in </td></tr>
  198. <tr><td class="paramname">filename</td><td>The filename to read from </td></tr>
  199. <tr><td class="paramname">delimiter</td><td>The delimiter used to separate the values in the file </td></tr>
  200. </table>
  201. </dd>
  202. </dl>
  203. </div>
  204. </div>
  205. <a class="anchor" id="a264c9b694fd7218635c8a783956d2c1e"></a>
  206. <div class="memitem">
  207. <div class="memproto">
  208. <table class="mlabels">
  209. <tr>
  210. <td class="mlabels-left">
  211. <table class="memname">
  212. <tr>
  213. <td class="memname">void util::FileIO::ReadCSV </td>
  214. <td>(</td>
  215. <td class="paramtype">Vector2d &amp;&#160;</td>
  216. <td class="paramname"><em>values</em>, </td>
  217. </tr>
  218. <tr>
  219. <td class="paramkey"></td>
  220. <td></td>
  221. <td class="paramtype">const std::string &amp;&#160;</td>
  222. <td class="paramname"><em>filename</em>, </td>
  223. </tr>
  224. <tr>
  225. <td class="paramkey"></td>
  226. <td></td>
  227. <td class="paramtype">char&#160;</td>
  228. <td class="paramname"><em>delimiter</em> = <code>';'</code>&#160;</td>
  229. </tr>
  230. <tr>
  231. <td></td>
  232. <td>)</td>
  233. <td></td><td></td>
  234. </tr>
  235. </table>
  236. </td>
  237. <td class="mlabels-right">
  238. <span class="mlabels"><span class="mlabel">static</span></span> </td>
  239. </tr>
  240. </table>
  241. </div><div class="memdoc">
  242. <p>Reads a CSV file and stores the values in a 2D array. The first dimension is the row and the second the value in that row. </p><dl class="params"><dt>Parameters</dt><dd>
  243. <table class="params">
  244. <tr><td class="paramname">values</td><td>The 2D array of values to store the read values in </td></tr>
  245. <tr><td class="paramname">filename</td><td>The filename to read from </td></tr>
  246. <tr><td class="paramname">delimiter</td><td>The delimiter used to separate the values in the file </td></tr>
  247. </table>
  248. </dd>
  249. </dl>
  250. </div>
  251. </div>
  252. <a class="anchor" id="a862586aced240e732ecd35773b57c267"></a>
  253. <div class="memitem">
  254. <div class="memproto">
  255. <table class="mlabels">
  256. <tr>
  257. <td class="mlabels-left">
  258. <table class="memname">
  259. <tr>
  260. <td class="memname">void util::FileIO::WriteCSVMatlab </td>
  261. <td>(</td>
  262. <td class="paramtype">DirectedGraph &amp;&#160;</td>
  263. <td class="paramname"><em>graph</em>, </td>
  264. </tr>
  265. <tr>
  266. <td class="paramkey"></td>
  267. <td></td>
  268. <td class="paramtype">const std::string &amp;&#160;</td>
  269. <td class="paramname"><em>file_name</em>, </td>
  270. </tr>
  271. <tr>
  272. <td class="paramkey"></td>
  273. <td></td>
  274. <td class="paramtype">char&#160;</td>
  275. <td class="paramname"><em>delimiter</em> = <code>';'</code>&#160;</td>
  276. </tr>
  277. <tr>
  278. <td></td>
  279. <td>)</td>
  280. <td></td><td></td>
  281. </tr>
  282. </table>
  283. </td>
  284. <td class="mlabels-right">
  285. <span class="mlabels"><span class="mlabel">static</span></span> </td>
  286. </tr>
  287. </table>
  288. </div><div class="memdoc">
  289. <p>Writes the given graph into a CSV file with an format readable by Matlab. </p><dl class="params"><dt>Parameters</dt><dd>
  290. <table class="params">
  291. <tr><td class="paramname">graph</td><td>The graph to write </td></tr>
  292. <tr><td class="paramname">file_name</td><td>The name of the file to write into </td></tr>
  293. <tr><td class="paramname">delimiter</td><td>The delimiter to use </td></tr>
  294. </table>
  295. </dd>
  296. </dl>
  297. </div>
  298. </div>
  299. <hr/>The documentation for this class was generated from the following files:<ul>
  300. <li>util/<a class="el" href="FileIO_8h_source.html">FileIO.h</a></li>
  301. <li>util/FileIO.cpp</li>
  302. </ul>
  303. </div><!-- contents -->
  304. <!-- start footer part -->
  305. <hr class="footer"/><address class="footer"><small>
  306. Generated by &#160;<a href="http://www.doxygen.org/index.html">
  307. <img class="footer" src="doxygen.png" alt="doxygen"/>
  308. </a> 1.8.12
  309. </small></address>
  310. </body>
  311. </html>