classutil_1_1FileIO.tex 3.7 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061
  1. \hypertarget{classutil_1_1FileIO}{}\section{util\+:\+:File\+IO Class Reference}
  2. \label{classutil_1_1FileIO}\index{util\+::\+File\+IO@{util\+::\+File\+IO}}
  3. {\ttfamily \#include $<$File\+I\+O.\+h$>$}
  4. \subsection*{Static Public Member Functions}
  5. \begin{DoxyCompactItemize}
  6. \item
  7. static void \hyperlink{classutil_1_1FileIO_acfce3977f435f2b024984da05408dfb4}{Read\+C\+SV} (core\+::\+Vector3d \&values, const std\+::string \&filename, const char \&delimiter=\textquotesingle{};\textquotesingle{})
  8. \item
  9. static void \hyperlink{classutil_1_1FileIO_a5d145cb872989165f76d00c343170bc5}{Read\+C\+SV} (core\+::\+Vector2d \&values, const std\+::string \&filename, const char \&delimiter=\textquotesingle{};\textquotesingle{})
  10. \end{DoxyCompactItemize}
  11. \subsection{Detailed Description}
  12. Utility class for file in-\/ and output.
  13. \subsection{Member Function Documentation}
  14. \index{util\+::\+File\+IO@{util\+::\+File\+IO}!Read\+C\+SV@{Read\+C\+SV}}
  15. \index{Read\+C\+SV@{Read\+C\+SV}!util\+::\+File\+IO@{util\+::\+File\+IO}}
  16. \subsubsection[{\texorpdfstring{Read\+C\+S\+V(core\+::\+Vector3d \&values, const std\+::string \&filename, const char \&delimiter=\textquotesingle{};\textquotesingle{})}{ReadCSV(core::Vector3d \&values, const std::string \&filename, const char \&delimiter=';')}}]{\setlength{\rightskip}{0pt plus 5cm}void util\+::\+File\+I\+O\+::\+Read\+C\+SV (
  17. \begin{DoxyParamCaption}
  18. \item[{core\+::\+Vector3d \&}]{values, }
  19. \item[{const std\+::string \&}]{filename, }
  20. \item[{const char \&}]{delimiter = {\ttfamily \textquotesingle{};\textquotesingle{}}}
  21. \end{DoxyParamCaption}
  22. )\hspace{0.3cm}{\ttfamily [static]}}\hypertarget{classutil_1_1FileIO_acfce3977f435f2b024984da05408dfb4}{}\label{classutil_1_1FileIO_acfce3977f435f2b024984da05408dfb4}
  23. Reads a C\+SV 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.
  24. \begin{DoxyParams}{Parameters}
  25. {\em values} & The 3D array of values to store the read values in \\
  26. \hline
  27. {\em filename} & The filename to read from \\
  28. \hline
  29. {\em delimiter} & The delimiter used to separate the values in the file \\
  30. \hline
  31. \end{DoxyParams}
  32. \index{util\+::\+File\+IO@{util\+::\+File\+IO}!Read\+C\+SV@{Read\+C\+SV}}
  33. \index{Read\+C\+SV@{Read\+C\+SV}!util\+::\+File\+IO@{util\+::\+File\+IO}}
  34. \subsubsection[{\texorpdfstring{Read\+C\+S\+V(core\+::\+Vector2d \&values, const std\+::string \&filename, const char \&delimiter=\textquotesingle{};\textquotesingle{})}{ReadCSV(core::Vector2d \&values, const std::string \&filename, const char \&delimiter=';')}}]{\setlength{\rightskip}{0pt plus 5cm}void util\+::\+File\+I\+O\+::\+Read\+C\+SV (
  35. \begin{DoxyParamCaption}
  36. \item[{core\+::\+Vector2d \&}]{values, }
  37. \item[{const std\+::string \&}]{filename, }
  38. \item[{const char \&}]{delimiter = {\ttfamily \textquotesingle{};\textquotesingle{}}}
  39. \end{DoxyParamCaption}
  40. )\hspace{0.3cm}{\ttfamily [static]}}\hypertarget{classutil_1_1FileIO_a5d145cb872989165f76d00c343170bc5}{}\label{classutil_1_1FileIO_a5d145cb872989165f76d00c343170bc5}
  41. Reads a C\+SV file and stores the values in a 2D array. The first dimension is the row and the second the value in that row.
  42. \begin{DoxyParams}{Parameters}
  43. {\em values} & The 2D array of values to store the read values in \\
  44. \hline
  45. {\em filename} & The filename to read from \\
  46. \hline
  47. {\em delimiter} & The delimiter used to separate the values in the file \\
  48. \hline
  49. \end{DoxyParams}
  50. The documentation for this class was generated from the following files\+:\begin{DoxyCompactItemize}
  51. \item
  52. util/File\+I\+O.\+h\item
  53. util/File\+I\+O.\+cpp\end{DoxyCompactItemize}