OpenMS  2.4.0
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-2018.
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: Timo Sachsenberg $
32 // $Authors: Andreas Bertsch, Marc Sturm, Stephan Aiche $
33 // --------------------------------------------------------------------------
34 
35 #pragma once
36 
37 #include <OpenMS/config.h>
39 
40 #include <string>
41 #include <map>
42 
43 namespace OpenMS
44 {
53  struct OPENMS_DLLAPI FileTypes
54  {
55  //NOTE: if you change/add something here, do not forget to change FileTypes::initializeMap_
56 
58  enum Type
59  {
61  DTA,
68  MGF,
69  INI,
72  MZML,
74  MS2,
79  QCML,
82  MSP,
85  PNG,
87  TSV,
93  EDTA,
94  CSV,
95  TXT,
96  OBO,
97  HTML,
98  XML,
100  XSD,
101  PSQ,
102  MRM,
104  PQP,
105  OSW,
107  PIN,
112  SIZE_OF_TYPE
113  };
114 
116  static String typeToName(Type type);
117 
119  static String typeToMZML(Type type);
120 
122  static Type nameToType(const String& name);
123 
124 private:
126  static const std::map<Type, String> name_of_types_;
127 
129  static const std::map<Type, String> name_of_MZMLtypes_;
130 
132  static std::map<Type, String> initializeMap_();
133 
135  static std::map<Type, String> initializeMZMLMap_();
136 
137  };
138 
139 } //namespace OpenMS
140 
OpenMS parameters file with workflow information (.toppas)
Definition: FileTypes.h:70
Type
Actual file types enum.
Definition: FileTypes.h:58
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:57
MS2 file (.ms2)
Definition: FileTypes.h:74
XSD schema format.
Definition: FileTypes.h:100
FASTA file (.fasta)
Definition: FileTypes.h:92
OpenMS identification format (.idXML)
Definition: FileTypes.h:66
CachedMzML file (.cachedmzML)
Definition: FileTypes.h:73
MzData file (.mzData)
Definition: FileTypes.h:63
Novor custom parameter file.
Definition: FileTypes.h:110
NCBI binary blast db.
Definition: FileTypes.h:101
general comma separated files format (might also be tab or space separated!!!), data should be regula...
Definition: FileTypes.h:94
Portable Network Graphics (.png)
Definition: FileTypes.h:85
mzTab file (.mzTab)
Definition: FileTypes.h:88
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:46
specArray file (.peplist)
Definition: FileTypes.h:89
internal format for writing and reading parameters (also used as part of CTD)
Definition: FileTypes.h:108
Centralizes the file types recognized by FileHandler.
Definition: FileTypes.h:53
mzQuantML (HUPO PSI AnalysisXML followup format) (.mzq)
Definition: FileTypes.h:78
OpenMS consensus map format (.consensusXML)
Definition: FileTypes.h:67
OMSSA XML file format for peptide identifications (.xml)
Definition: FileTypes.h:83
analysisXML format
Definition: FileTypes.h:99
Mascot XML file format for peptide identifications (.xml)
Definition: FileTypes.h:84
enhanced comma separated files (RT, m/z, Intensity, [meta])
Definition: FileTypes.h:93
TPP protXML file (.protXML)
Definition: FileTypes.h:76
Unknown file extension.
Definition: FileTypes.h:60
mzIdentML (HUPO PSI AnalysisXML followup format) (.mzid)
Definition: FileTypes.h:77
DTA file (.dta)
Definition: FileTypes.h:61
OpenSWATH Peptide Query Parameter (PQP) SQLite DB.
Definition: FileTypes.h:104
XMass Analysis file (fid)
Definition: FileTypes.h:86
kroenik file (.kroenik)
Definition: FileTypes.h:91
SpectraST binary spectral library file (sptxt is the equivalent text-based format, similar to the MSP format)
Definition: FileTypes.h:109
TraML (HUPO PSI format) for transitions (.traML)
Definition: FileTypes.h:81
qcML (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 h...
Definition: FileTypes.h:95
any HTML format
Definition: FileTypes.h:97
OpenMS feature file (.featureXML)
Definition: FileTypes.h:65
Controlled Vocabulary format.
Definition: FileTypes.h:96
xQuest XML file format for protein-protein cross-link identifications (.xquest.xml) ...
Definition: FileTypes.h:111
Transformation description file (.trafoXML)
Definition: FileTypes.h:71
static const std::map< Type, String > name_of_types_
Maps the FileType::Type to the preferred extension.
Definition: FileTypes.h:126
Percolator tab-delimited output (PSM level)
Definition: FileTypes.h:106
any XML format
Definition: FileTypes.h:98
static const std::map< Type, String > name_of_MZMLtypes_
Maps the FileType::Type to the preferred mzML CV name.
Definition: FileTypes.h:129
hardkloer file (.hardkloer)
Definition: FileTypes.h:90
Percolator tab-delimited input (PSM level)
Definition: FileTypes.h:107
OpenSWATH OpenSWATH report (OSW) SQLite DB.
Definition: FileTypes.h:105
GelML (HUPO PSI format) (.gelML)
Definition: FileTypes.h:80
SqLite format for mass and chromatograms.
Definition: FileTypes.h:103
DTA2D file (.dta2d)
Definition: FileTypes.h:62
Mascot Generic Format (.mgf)
Definition: FileTypes.h:68
MzML file (.mzML)
Definition: FileTypes.h:72
SpectraST MRM List.
Definition: FileTypes.h:102
OpenMS parameters file (.ini)
Definition: FileTypes.h:69
MzXML file (.mzXML)
Definition: FileTypes.h:64
TPP pepXML file (.pepXML)
Definition: FileTypes.h:75