MSPGenericFile.h

Go to the documentation of this file.

// Copyright (c) 2002-2023, The OpenMS Team -- EKU Tuebingen, ETH Zurich, and FU Berlin
// SPDX-License-Identifier: BSD-3-Clause
//
// --------------------------------------------------------------------------
// $Maintainer: Douglas McCloskey, Pasquale Domenico Colaianni $
// $Authors: Douglas McCloskey, Pasquale Domenico Colaianni $
// --------------------------------------------------------------------------
 
#pragma once
 
#include <OpenMS/config.h> // OPENMS_DLLAPI
#include <OpenMS/DATASTRUCTURES/DefaultParamHandler.h>
#include <OpenMS/DATASTRUCTURES/String.h>
#include <OpenMS/KERNEL/MSExperiment.h>
 
namespace OpenMS
{
  class OPENMS_DLLAPI MSPGenericFile :
    public DefaultParamHandler
  {
public:
    MSPGenericFile();
 
    MSPGenericFile(const String& filename, MSExperiment& library);
 
    ~MSPGenericFile() override = default;
 
    void getDefaultParameters(Param& params);
 
    friend class MSPGenericFile_friend;
 
    void load(const String& filename, MSExperiment& library);
 
    void store(const String& filename, const MSExperiment& library) const;
  
  private:
    void updateMembers_() override;
 
    void addSpectrumToLibrary(
      MSSpectrum& spectrum,
      MSExperiment& library
    );
 
    std::set<String> loaded_spectra_names_;
 
    /*
      The synonyms of a spectrum are collected into this variable and,
      when `addSpectrumtoLibrary()` is called, the elements are concatenated
      and the result is saved as a "Synon" metaValue.
      The synonyms are separated by `synonyms_separator_`.
    */
    std::vector<String> synonyms_;
 
    String synonyms_separator_;
  };
 
  class MSPGenericFile_friend
  {
public:
    MSPGenericFile_friend() = default;
    ~MSPGenericFile_friend() = default;
 
    void addSpectrumToLibrary(
      MSSpectrum& spectrum,
      MSExperiment& library
    )
    {
      return msp_.addSpectrumToLibrary(spectrum, library);
    }
 
    MSPGenericFile msp_;
  };
}