Home  · Classes  · Annotated Classes  · Modules  · Members  · Namespaces  · Related Pages
CsvFile.h
Go to the documentation of this file.
1 // --------------------------------------------------------------------------
2 // OpenMS -- Open-Source Mass Spectrometry
3 // --------------------------------------------------------------------------
4 // Copyright The OpenMS Team -- Eberhard Karls University Tuebingen,
5 // ETH Zurich, and Freie Universitaet Berlin 2002-2013.
6 //
7 // This software is released under a three-clause BSD license:
8 // * Redistributions of source code must retain the above copyright
9 // notice, this list of conditions and the following disclaimer.
10 // * Redistributions in binary form must reproduce the above copyright
11 // notice, this list of conditions and the following disclaimer in the
12 // documentation and/or other materials provided with the distribution.
13 // * Neither the name of any author or any participating institution
14 // may be used to endorse or promote products derived from this software
15 // without specific prior written permission.
16 // For a full list of authors, refer to the file AUTHORS.
17 // --------------------------------------------------------------------------
18 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19 // AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 // ARE DISCLAIMED. IN NO EVENT SHALL ANY OF THE AUTHORS OR THE CONTRIBUTING
22 // INSTITUTIONS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
23 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
24 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
25 // OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
26 // WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
27 // OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
28 // ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29 //
30 // --------------------------------------------------------------------------
31 // $Maintainer: David Wojnar $
32 // $Authors: David Wojnar $
33 // --------------------------------------------------------------------------
34 
35 #ifndef OPENMS_FORMAT_CSVFILE_H
36 #define OPENMS_FORMAT_CSVFILE_H
37 
38 #include <OpenMS/FORMAT/TextFile.h>
39 
40 namespace OpenMS
41 {
42  class StringList;
50  class OPENMS_DLLAPI CsvFile :
51  public TextFile
52  {
53 public:
54 
56  CsvFile();
57 
59  virtual ~CsvFile();
60 
72  CsvFile(const String & filename, char is = ',', bool ie = false, Int first_n = -1);
73 
84  void fload(const String & filename, char is = ',', bool ie = false, Int first_n = -1);
85 
97  bool getRow(Size row, StringList & list);
98 
99 private:
102 
103 
104  };
105 
106 } // namespace OpenMS
107 
108 #endif // OPENMS_FORMAT_CSVFILE_H
A more convenient string class.
Definition: String.h:56
This class handles csv files. Currently only loading is implemented.
Definition: CsvFile.h:50
char itemseperator_
Definition: CsvFile.h:100
bool itemenclosed_
Definition: CsvFile.h:101
String list.
Definition: StringList.h:56
size_t Size
Size type e.g. used as variable which can hold result of size()
Definition: Types.h:144
int Int
Signed integer type.
Definition: Types.h:100
This class provides some basic file handling methods for text files.
Definition: TextFile.h:47

OpenMS / TOPP release 1.11.1 Documentation generated on Thu Nov 14 2013 11:19:12 using doxygen 1.8.5