MSDataWritingConsumer.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: Hannes Roest $
// $Authors: Hannes Roest $
// --------------------------------------------------------------------------
 
#pragma once
 
#include <OpenMS/INTERFACES/IMSDataConsumer.h>
 
#include <OpenMS/FORMAT/HANDLERS/MzMLHandler.h>
#include <OpenMS/CONCEPT/ProgressLogger.h>
 
#include <vector>
#include <string>
#include <fstream>
#include <memory>
 
namespace OpenMS
{
    class OPENMS_DLLAPI MSDataWritingConsumer : 
      public Internal::MzMLHandler,
      public Interfaces::IMSDataConsumer
    {
 
    public:
      typedef PeakMap MapType;
      typedef MapType::SpectrumType SpectrumType;
      typedef MapType::ChromatogramType ChromatogramType;
 
      explicit MSDataWritingConsumer(const String& filename);
 
      ~MSDataWritingConsumer() override;
 
 
 
      void setExperimentalSettings(const ExperimentalSettings& exp) override;
 
      void setExpectedSize(Size expectedSpectra, Size expectedChromatograms) override;
 
      void consumeSpectrum(SpectrumType & s) override;
 
      void consumeChromatogram(ChromatogramType & c) override;
 
      virtual void addDataProcessing(DataProcessing d);
 
      virtual Size getNrSpectraWritten();
 
      virtual Size getNrChromatogramsWritten();
 
    private:
 
 
 
      virtual void processSpectrum_(SpectrumType & s) = 0;
 
      virtual void processChromatogram_(ChromatogramType & c) = 0;
 
      virtual void doCleanup_();
 
    protected:
 
      std::ofstream ofs_;
 
      bool started_writing_;
      bool writing_spectra_;
      bool writing_chromatograms_;
      Size spectra_written_;
      Size chromatograms_written_;
      Size spectra_expected_;
      Size chromatograms_expected_;
      bool add_dataprocessing_;
 
      Internal::MzMLValidator * validator_;
 
      ExperimentalSettings settings_;
      std::vector<std::vector< ConstDataProcessingPtr > > dps_;
      DataProcessingPtr additional_dataprocessing_;
    };
 
    class OPENMS_DLLAPI PlainMSDataWritingConsumer :
      public MSDataWritingConsumer 
    {
      void processSpectrum_(MapType::SpectrumType & /* s */) override {}
      void processChromatogram_(MapType::ChromatogramType & /* c */) override {}
 
    public:
 
      explicit PlainMSDataWritingConsumer(String filename) : MSDataWritingConsumer(filename) {}
    };
 
    class OPENMS_DLLAPI NoopMSDataWritingConsumer :
      public MSDataWritingConsumer 
    {
    public:
 
      explicit NoopMSDataWritingConsumer(String filename) : MSDataWritingConsumer(filename) {}
      void setExperimentalSettings(const ExperimentalSettings& /* exp */) override {}
      void consumeSpectrum(SpectrumType & /* s */) override {}
      void consumeChromatogram(ChromatogramType & /* c */) override {}
 
    private:
 
      void doCleanup_() override {}
      void processSpectrum_(MapType::SpectrumType & /* s */) override {}
      void processChromatogram_(MapType::ChromatogramType & /* c */) override {}
    };
 
 
} //end namespace OpenMS