00001 /* 00002 00003 This file is part of OpenFLUID software 00004 Copyright(c) 2007, INRA - Montpellier SupAgro 00005 00006 00007 == GNU General Public License Usage == 00008 00009 OpenFLUID is free software: you can redistribute it and/or modify 00010 it under the terms of the GNU General Public License as published by 00011 the Free Software Foundation, either version 3 of the License, or 00012 (at your option) any later version. 00013 00014 OpenFLUID is distributed in the hope that it will be useful, 00015 but WITHOUT ANY WARRANTY; without even the implied warranty of 00016 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 00017 GNU General Public License for more details. 00018 00019 You should have received a copy of the GNU General Public License 00020 along with OpenFLUID. If not, see <http://www.gnu.org/licenses/>. 00021 00022 00023 == Other Usage == 00024 00025 Other Usage means a use of OpenFLUID that is inconsistent with the GPL 00026 license, and requires a written agreement between You and INRA. 00027 Licensees for Other Usage of OpenFLUID may use this file in accordance 00028 with the terms contained in the written agreement between You and INRA. 00029 00030 */ 00031 00032 00033 /** 00034 \file ProgressiveColumnFileReader.hpp 00035 \brief Header of ... 00036 00037 \author Jean-Christophe FABRE <fabrejc@supagro.inra.fr> 00038 */ 00039 00040 00041 #ifndef __PROGRESSIVECOLUMNFILEREADER_HPP__ 00042 #define __PROGRESSIVECOLUMNFILEREADER_HPP__ 00043 00044 00045 #include <fstream> 00046 #include <vector> 00047 00048 #include <openfluid/dllexport.hpp> 00049 00050 00051 namespace openfluid { namespace tools { 00052 00053 /** 00054 Progressive reader for column text files 00055 */ 00056 class DLLEXPORT ProgressiveColumnFileReader 00057 { 00058 private: 00059 00060 std::ifstream m_File; 00061 00062 std::string m_ColSeparators; 00063 00064 00065 protected: 00066 00067 std::string m_FileName; 00068 00069 00070 public: 00071 00072 /** 00073 Constructor 00074 @param[in] FileName the file to open 00075 @param[in] ColSeparators a list of columns separators. Default value is " \t\r\n" 00076 */ 00077 ProgressiveColumnFileReader(const std::string& FileName, 00078 const std::string& ColSeparators = " \t\r\n"); 00079 00080 virtual ~ProgressiveColumnFileReader() 00081 { }; 00082 00083 /** 00084 Gets the next line of data in the file, as a single string 00085 @param[out] Line the read line 00086 @return true if the next line has been read, false otherwise 00087 */ 00088 bool getNextLine(std::string& Line); 00089 00090 /** 00091 Gets the next line of data in the file, as a vector of strings 00092 @param[out] Values the vector of read values 00093 @return true if the next line has been read and splitted into a vector of strings, 00094 false otherwise 00095 */ 00096 bool getNextLine(std::vector<std::string>& Values); 00097 00098 /** 00099 Resets the internal iterator of the file 00100 */ 00101 void reset(); 00102 00103 /** 00104 Returns the file name 00105 @return the file name 00106 */ 00107 std::string getFileName() const { return m_FileName; }; 00108 00109 }; 00110 00111 00112 } } // namespaces 00113 00114 00115 #endif /* __PROGRESSIVECOLUMNFILEREADER_HPP__ */