DataProcessing.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: Marc Sturm $
// --------------------------------------------------------------------------
 
#pragma once
 
#include <OpenMS/METADATA/MetaInfoInterface.h>
#include <OpenMS/METADATA/Software.h>
#include <OpenMS/DATASTRUCTURES/DateTime.h>
#include <OpenMS/DATASTRUCTURES/ListUtils.h>
 
#include <set>
#include <memory>
 
namespace OpenMS
{
  class OPENMS_DLLAPI DataProcessing :
    public MetaInfoInterface
  {
 
public:
 
    //The different processing types
    enum ProcessingAction
    {
      DATA_PROCESSING,                
      CHARGE_DECONVOLUTION,               
      DEISOTOPING,                                
      SMOOTHING,                                  
      CHARGE_CALCULATION,             
      PRECURSOR_RECALCULATION,          
      BASELINE_REDUCTION,                 
      PEAK_PICKING,                           
      ALIGNMENT,                                  
      CALIBRATION,                                  
      NORMALIZATION,                            
      FILTERING,                                  
      QUANTITATION,                             
      FEATURE_GROUPING,                     
      IDENTIFICATION_MAPPING,           
      FORMAT_CONVERSION,              
      CONVERSION_MZDATA,                  
      CONVERSION_MZML,                        
      CONVERSION_MZXML,                       
      CONVERSION_DTA,                 
      IDENTIFICATION,                 
      ION_MOBILITY_BINNING,           
      SIZE_OF_PROCESSINGACTION
    };
    static const std::string NamesOfProcessingAction[SIZE_OF_PROCESSINGACTION];
 
    static StringList getAllNamesOfProcessingAction();
 
    static const std::string& processingActionToString(ProcessingAction action);
 
    static ProcessingAction toProcessingAction(const std::string& name);
 
    DataProcessing() = default;
    DataProcessing(const DataProcessing&) = default;
 
    // note: we implement the move constructor ourselves due to a bug in MSVS
    // 2015/2017 which cannot produce a default move constructor for classes
    // that contain STL containers (other than vector).
 
    DataProcessing(DataProcessing&&) noexcept;
    ~DataProcessing();
 
    DataProcessing& operator=(const DataProcessing&) = default;
    DataProcessing& operator=(DataProcessing&&)& = default;
 
    bool operator==(const DataProcessing& rhs) const;
    bool operator!=(const DataProcessing& rhs) const;
 
    const Software& getSoftware() const;
    Software& getSoftware();
    void setSoftware(const Software& software);
 
    const std::set<ProcessingAction>& getProcessingActions() const;
    std::set<ProcessingAction>& getProcessingActions();
    void setProcessingActions(const std::set<ProcessingAction>& actions);
 
    const DateTime& getCompletionTime() const;
    void setCompletionTime(const DateTime& completion_time);
 
protected:
 
    Software software_;
    std::set<ProcessingAction> processing_actions_;
    DateTime completion_time_;
  };
 
  typedef std::shared_ptr<DataProcessing> DataProcessingPtr;
  typedef std::shared_ptr<const DataProcessing> ConstDataProcessingPtr;
 
} // namespace OpenMS