Home  · Classes  · Annotated Classes  · Modules  · Members  · Namespaces  · Related Pages
FileTypes.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: Stephan Aiche $
32 // $Authors: Andreas Bertsch, Marc Sturm, Stephan Aiche $
33 // --------------------------------------------------------------------------
34 
35 #ifndef OPENMS_FORMAT_FILETYPES_H
36 #define OPENMS_FORMAT_FILETYPES_H
37 
38 #include <OpenMS/config.h>
40 
41 #include <string>
42 #include <map>
43 
44 namespace OpenMS
45 {
54  struct OPENMS_DLLAPI FileTypes
55  {
56  //NOTE: if you change/add something here, do not forget to change FileTyoes::initializeMap_
57 
59  enum Type
60  {
62  DTA,
69  MGF,
70  INI,
73  MZML,
74  MS2,
79  QCML,
82  MSP,
85  PNG,
87  TSV,
92  EDTA,
93  CSV,
94  TXT,
95  OBO,
96  HTML,
97  XML,
99  XSD,
100  PSQ,
101  SIZE_OF_TYPE
102  };
103 
105  static String typeToName(Type type);
106 
108  static String typeToMZML(Type type);
109 
111  static Type nameToType(const String& name);
112 
113 private:
115  static const std::map<Type, String> name_of_types_;
116 
118  static const std::map<Type, String> name_of_MZMLtypes_;
119 
121  static std::map<Type, String> initializeMap_();
122 
124  static std::map<Type, String> initializeMZMLMap_();
125 
126  };
127 
128 } //namespace OpenMS
129 
130 #endif //OPENMS_FORMAT_FILETYPES_H
OpenMS parameters file with workflow information (.toppas)
Definition: FileTypes.h:71
Type
Actual file types enum.
Definition: FileTypes.h:59
msInspect file (.tsv)
Definition: FileTypes.h:87
NIST spectra library file format (.msp)
Definition: FileTypes.h:82
A more convenient string class.
Definition: String.h:56
MS2 file (.ms2)
Definition: FileTypes.h:74
XSD schema format.
Definition: FileTypes.h:99
FASTA file (.fasta)
Definition: FileTypes.h:91
OpenMS identification format (.idXML)
Definition: FileTypes.h:67
MzData file (.mzData)
Definition: FileTypes.h:64
NCBI binary blast db.
Definition: FileTypes.h:100
general comma separated files format (might also be tab or space separated!!!), data should be regula...
Definition: FileTypes.h:93
Portable Network Graphics (.png)
Definition: FileTypes.h:85
specArray file (.peplist)
Definition: FileTypes.h:88
Centralizes the file types recognized by FileHandler.
Definition: FileTypes.h:54
mzQuantML (HUPO PSI AnalysisXML followup format) (.mzq)
Definition: FileTypes.h:78
OpenMS consensus map format (.consensusXML)
Definition: FileTypes.h:68
OMSSA XML file format for peptide identifications (.xml)
Definition: FileTypes.h:83
analysisXML format
Definition: FileTypes.h:98
Mascot XML file format for peptide identifications (.xml)
Definition: FileTypes.h:84
enhanced comma separated files (RT, m/z, Intensity, [meta])
Definition: FileTypes.h:92
TPP protXML file (.protXML)
Definition: FileTypes.h:76
Unknown file extension.
Definition: FileTypes.h:61
mzIdentML (HUPO PSI AnalysisXML followup format) (.mzid)
Definition: FileTypes.h:77
DTA file (.dta)
Definition: FileTypes.h:62
XMass Analysis file (fid)
Definition: FileTypes.h:86
kroenik file (.kroenik)
Definition: FileTypes.h:90
TraML (HUPO PSI format) for transitions (.traML)
Definition: FileTypes.h:81
mzQualityML (will undergo standardisation maybe) (.qcml)
Definition: FileTypes.h:79
any text format, which has only loose definition of what it actually contains – thus it is usually ha...
Definition: FileTypes.h:94
any HTML format
Definition: FileTypes.h:96
OpenMS feature file (.featureXML)
Definition: FileTypes.h:66
Controlled Vocabulary format.
Definition: FileTypes.h:95
Tranformation description file (.trafoXML)
Definition: FileTypes.h:72
static const std::map< Type, String > name_of_types_
Maps the FileType::Type to the preferred extension.
Definition: FileTypes.h:115
any XML format
Definition: FileTypes.h:97
static const std::map< Type, String > name_of_MZMLtypes_
Maps the FileType::Type to the preferred mzML CV name.
Definition: FileTypes.h:118
hardkloer file (.hardkloer)
Definition: FileTypes.h:89
GelML (HUPO PSI format) (.gelML)
Definition: FileTypes.h:80
DTA2D file (.dta2d)
Definition: FileTypes.h:63
Mascot Generic Format (.mgf)
Definition: FileTypes.h:69
MzML file (.mzML)
Definition: FileTypes.h:73
OpenMS parameters file (.ini)
Definition: FileTypes.h:70
MzXML file (.mzXML)
Definition: FileTypes.h:65
TPP pepXML file (.pepXML)
Definition: FileTypes.h:75

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