InstrumentSettings.h

Go to the documentation of this file.

// --------------------------------------------------------------------------
//                   OpenMS -- Open-Source Mass Spectrometry
// --------------------------------------------------------------------------
// Copyright The OpenMS Team -- Eberhard Karls University Tuebingen,
// ETH Zurich, and Freie Universitaet Berlin 2002-2018.
//
// This software is released under a three-clause BSD license:
//  * Redistributions of source code must retain the above copyright
//    notice, this list of conditions and the following disclaimer.
//  * Redistributions in binary form must reproduce the above copyright
//    notice, this list of conditions and the following disclaimer in the
//    documentation and/or other materials provided with the distribution.
//  * Neither the name of any author or any participating institution
//    may be used to endorse or promote products derived from this software
//    without specific prior written permission.
// For a full list of authors, refer to the file AUTHORS.
// --------------------------------------------------------------------------
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
// ARE DISCLAIMED. IN NO EVENT SHALL ANY OF THE AUTHORS OR THE CONTRIBUTING
// INSTITUTIONS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
// OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
// WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
// OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
// ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// --------------------------------------------------------------------------
// $Maintainer: Timo Sachsenberg $
// $Authors: Marc Sturm $
// --------------------------------------------------------------------------

#pragma once

#include <OpenMS/METADATA/ScanWindow.h>
#include <OpenMS/METADATA/IonSource.h>

namespace OpenMS
{
  class OPENMS_DLLAPI InstrumentSettings :
    public MetaInfoInterface
  {
public:
    enum ScanMode
    {
      UNKNOWN,                      
      MASSSPECTRUM,       
      MS1SPECTRUM,              
      MSNSPECTRUM,        
      SIM,                              
      SRM,                              
      CRM,                              
      CNG,                              
      CNL,                              
      PRECURSOR,                
      EMC,                              
      TDF,                              
      EMR,                              
      EMISSION,                     
      ABSORPTION,               
      SIZE_OF_SCANMODE
    };

    static const std::string NamesOfScanMode[SIZE_OF_SCANMODE];

    InstrumentSettings();
    InstrumentSettings(const InstrumentSettings & source);
    ~InstrumentSettings();

    InstrumentSettings & operator=(const InstrumentSettings & source);

    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