SpectrumSettings.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, Timo Sachsenberg $
// --------------------------------------------------------------------------
 
#pragma once
 
#include <OpenMS/DATASTRUCTURES/String.h>
#include <OpenMS/METADATA/InstrumentSettings.h>
#include <OpenMS/METADATA/AcquisitionInfo.h>
#include <OpenMS/METADATA/SourceFile.h>
#include <OpenMS/METADATA/Precursor.h>
#include <OpenMS/METADATA/Product.h>
#include <OpenMS/METADATA/PeptideIdentification.h>
#include <OpenMS/METADATA/DataProcessing.h>
#include <OpenMS/IONMOBILITY/IMTypes.h>
#include <OpenMS/DATASTRUCTURES/ListUtils.h>
 
#include <map>
#include <vector>
 
namespace OpenMS
{
  class OPENMS_DLLAPI SpectrumSettings :
    public MetaInfoInterface
  {
 
public:
 
    enum SpectrumType
    {
      UNKNOWN,          
      CENTROID,         
      PROFILE,          
      SIZE_OF_SPECTRUMTYPE
    };
    static const std::string NamesOfSpectrumType[SIZE_OF_SPECTRUMTYPE];
 
    static StringList getAllNamesOfSpectrumType();
 
    SpectrumSettings() = default;
    SpectrumSettings(const SpectrumSettings &) = default;
    SpectrumSettings(SpectrumSettings&&) noexcept = default;
    ~SpectrumSettings() noexcept = default;
 
    // Assignment operator
    SpectrumSettings & operator=(const SpectrumSettings &) = default;
    SpectrumSettings& operator=(SpectrumSettings&&) & = default;
 
    bool operator==(const SpectrumSettings & rhs) const;
    bool operator!=(const SpectrumSettings & rhs) const;
 
    void unify(const SpectrumSettings & rhs);
 
    SpectrumType getType() const;
    void setType(SpectrumType type);
 
    void setIMFormat(const IMFormat& im_type);
 
    IMFormat getIMFormat() const;
 
    const String & getNativeID() const;
    void setNativeID(const String & native_id);
 
    const String & getComment() const;
    void setComment(const String & comment);
 
    const InstrumentSettings & getInstrumentSettings() const;
    InstrumentSettings & getInstrumentSettings();
    void setInstrumentSettings(const InstrumentSettings & instrument_settings);
 
    const AcquisitionInfo & getAcquisitionInfo() const;
    AcquisitionInfo & getAcquisitionInfo();
    void setAcquisitionInfo(const AcquisitionInfo & acquisition_info);
 
    const SourceFile & getSourceFile() const;
    SourceFile & getSourceFile();
    void setSourceFile(const SourceFile & source_file);
 
    const std::vector<Precursor> & getPrecursors() const;
    std::vector<Precursor> & getPrecursors();
    void setPrecursors(const std::vector<Precursor> & precursors);
 
    const std::vector<Product> & getProducts() const;
    std::vector<Product> & getProducts();
    void setProducts(const std::vector<Product> & products);
 
    void setDataProcessing(const std::vector< DataProcessingPtr > & data_processing);
 
    std::vector< DataProcessingPtr > & getDataProcessing();
 
    const std::vector< std::shared_ptr<const DataProcessing > > getDataProcessing() const;
 
protected:
 
    SpectrumType type_ = UNKNOWN;
    IMFormat im_type_ = IMFormat::UNKNOWN;
    String native_id_;
    String comment_;
    InstrumentSettings instrument_settings_;
    SourceFile source_file_;
    AcquisitionInfo acquisition_info_;
    std::vector<Precursor> precursors_;
    std::vector<Product> products_;
    std::vector< DataProcessingPtr > data_processing_;
  };
 
  OPENMS_DLLAPI std::ostream & operator<<(std::ostream & os, const SpectrumSettings & spec);
 
} // namespace OpenMS