FileTypes.h

Go to the documentation of this file.

// Copyright (c) 2002-present, OpenMS Inc. -- EKU Tuebingen, ETH Zurich, and FU Berlin
// SPDX-License-Identifier: BSD-3-Clause
//
// --------------------------------------------------------------------------
// $Maintainer: Timo Sachsenberg $
// $Authors: Stephan Aiche, Andreas Bertsch, Marc Sturm, Chris Bielow $
// --------------------------------------------------------------------------
 
#pragma once
 
#include <OpenMS/config.h>
#include <OpenMS/DATASTRUCTURES/String.h>
 
#include <vector>
 
namespace OpenMS
{
  struct OPENMS_DLLAPI FileTypes
  {
 
    enum Type
    {
      UNKNOWN,            
      DTA,                
      DTA2D,              
      MZDATA,             
      MZXML,              
      FEATUREXML,         
      IDXML,              
      CONSENSUSXML,       
      MGF,                
      INI,                
      TOPPAS,             
      TRANSFORMATIONXML,  
      MZML,               
      CACHEDMZML,         
      MS2,                
      PEPXML,             
      PROTXML,            
      MZIDENTML,          
      QCML,               
      MZQC,               
      GELML,              
      TRAML,              
      MSP,                
      OMSSAXML,           
      MASCOTXML,          
      PNG,                
      XMASS,              
      TSV,                
      MZTAB,              
      PEPLIST,            
      HARDKLOER,          
      KROENIK,            
      FASTA,              
      EDTA,               
      CSV,                
      TXT,                
      OBO,                
      HTML,               
      ANALYSISXML,        
      XSD,                
      PSQ,                
      MRM,                
      SQMASS,             
      PQP,                
      MS,                 
      OSW,                
      PSMS,               
      PIN,                
      PARAMXML,           
      SPLIB,              
      NOVOR,              
      XQUESTXML,          
      SPECXML,            
      JSON,               
      RAW,                
      OMS,                
      EXE,                
      XML,                
      BZ2,                
      GZ,                 
      SIZE_OF_TYPE        
    };
 
    enum class FileProperties
    {
      READABLE,                     // SOMETHING in OpenMS can read this (it doesn't have to be in FileHandler though)
      WRITEABLE,                    // SOMETHING in OpenMS can write this (it doesn't have to be in FileHandler though) 
      PROVIDES_SPECTRUM,            // All of the PROVIDES_x properties correspond to which FileHandlers are implemented for a file type.
      PROVIDES_EXPERIMENT,          // 
      PROVIDES_FEATURES,            //
      PROVIDES_CONSENSUSFEATURES,   //
      PROVIDES_IDENTIFICATIONS,     //
      PROVIDES_TRANSITIONS,         //
      PROVIDES_QUANTIFICATIONS,     //
      PROVIDES_TRANSFORMATIONS,     //
      PROVIDES_QC,                  //
      SIZE_OF_FILEPROPERTIES        // Not a property, just the number of 'em
    };
 
    static String typeToName(Type type);
    
    static String typeToDescription(Type type);
    
    static Type nameToType(const String& name);
 
    static String typeToMZML(Type type);
  };
 
 enum class FilterLayout
  {
    COMPACT,    
    ONE_BY_ONE, 
    BOTH        
  };
  class OPENMS_DLLAPI FileTypeList
  {
  public:
    FileTypeList(const std::vector<FileTypes::Type>& types);
 
    bool contains(const FileTypes::Type& type) const;
 
    const std::vector<FileTypes::Type>& getTypes() const
    {
      return type_list_;
    }
 
    String toFileDialogFilter(const FilterLayout style, bool add_all_filter) const;
 
    FileTypes::Type fromFileDialogFilter(const String& filter, const FileTypes::Type fallback = FileTypes::Type::UNKNOWN) const;
 
 
    static std::vector<FileTypes::Type> typesWithProperties(const std::vector<FileTypes::FileProperties> features);
 
  private:
    struct FilterElements_
    {
      std::vector<String> items;
      std::vector<FileTypes::Type> types;
    };
    FilterElements_ asFilterElements_(const FilterLayout style, bool add_all_filter) const;
 
    std::vector<FileTypes::Type> type_list_;
  };
 
} // namespace OpenMS