InstrumentSettings.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/ScanWindow.h>
#include <OpenMS/METADATA/IonSource.h>
#include <OpenMS/DATASTRUCTURES/ListUtils.h>
 
namespace OpenMS
{
  class OPENMS_DLLAPI InstrumentSettings :
    public MetaInfoInterface
  {
public:
    enum class ScanMode
    {
      UNKNOWN,          
      MASSSPECTRUM,     
      MS1SPECTRUM,      
      MSNSPECTRUM,      
      SIM,              
      SRM,              
      CRM,              
      CNG,              
      CNL,              
      PRECURSOR,        
      EMC,              
      TDF,              
      EMR,              
      EMISSION,         
      ABSORPTION,       
      SIZE_OF_SCANMODE
    };
 
    static const std::string NamesOfScanMode[static_cast<size_t>(ScanMode::SIZE_OF_SCANMODE)];
 
    static StringList getAllNamesOfScanMode();
 
    static const std::string& scanModeToString(ScanMode mode);
 
    static ScanMode toScanMode(const std::string& name);
 
    InstrumentSettings();
    InstrumentSettings(const InstrumentSettings &) = default;
    InstrumentSettings(InstrumentSettings&&) = default;
    ~InstrumentSettings();
 
    InstrumentSettings & operator=(const InstrumentSettings &) = default;
    InstrumentSettings& operator=(InstrumentSettings&&) & = default;
 
    bool operator==(const InstrumentSettings & rhs) const;
    bool operator!=(const InstrumentSettings & rhs) const;
 
    ScanMode getScanMode() const;
    void setScanMode(ScanMode scan_mode);
 
    bool getZoomScan() const;
    void setZoomScan(bool zoom_scan);
 
    IonSource::Polarity getPolarity() const;
    void setPolarity(IonSource::Polarity polarity);
 
    const std::vector<ScanWindow> & getScanWindows() const;
    std::vector<ScanWindow> & getScanWindows();
    void setScanWindows(std::vector<ScanWindow>  scan_windows);
 
protected:
    ScanMode scan_mode_;
    bool zoom_scan_;
    IonSource::Polarity polarity_;
    std::vector<ScanWindow> scan_windows_;
  };
} // namespace OpenMS