MRMFeatureQCFile.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: Douglas McCloskey, Pasquale Domenico Colaianni $
// $Authors: Douglas McCloskey, Pasquale Domenico Colaianni $
// --------------------------------------------------------------------------
 
#pragma once
 
#include <OpenMS/FORMAT/CsvFile.h>
#include <OpenMS/CONCEPT/ProgressLogger.h>
#include <OpenMS/DATASTRUCTURES/StringListUtils.h>
#include <OpenMS/ANALYSIS/OPENSWATH/MRMFeatureQC.h>
 
namespace OpenMS
{
  class OPENMS_DLLAPI MRMFeatureQCFile :
    private CsvFile,
    public ProgressLogger
  {
public:
  MRMFeatureQCFile() = default;
  ~MRMFeatureQCFile() override = default;
 
  void load(const std::string& filename, MRMFeatureQC& mrmfqc, const bool is_component_group) const;
 
  /*
    @brief Stores an MRMFeatureQC file.
 
    @exception Exception::UnableToCreateFile is thrown if the file could not be created
 
    @param[in] filename The path to the input file
    @param[in] mrmfqc The output class which will contain the criteria
    @param[in] is_component_group true if the user intends to store ComponentGroupQCs data, false otherwise
  */
  void store(const std::string& filename, const MRMFeatureQC& mrmfqc, const bool is_component_group);
protected:
  void pushValuesFromLine_(
    const StringList& line,
    const std::map<std::string, Size>& headers,
    std::vector<MRMFeatureQC::ComponentQCs>& c_qcs
  ) const;
 
  void pushValuesFromLine_(
    const StringList& line,
    const std::map<std::string, Size>& headers,
    std::vector<MRMFeatureQC::ComponentGroupQCs>& cg_qcs
  ) const;
 
  void setPairValue_(
    const std::string& key,
    const std::string& value,
    const std::string& boundary,
    std::map<std::string, std::pair<double,double>>& meta_values_qc
  ) const;
 
  Int getCastValue_(
    const std::map<std::string, Size>& headers,
    const StringList& line,
    const std::string& header,
    const Int default_value
  ) const;
 
  double getCastValue_(
    const std::map<std::string, Size>& headers,
    const StringList& line,
    const std::string& header,
    const double default_value
  ) const;
 
  std::string getCastValue_(
    const std::map<std::string, Size>& headers,
    const StringList& line,
    const std::string& header,
    const std::string& default_value
  ) const;
 
  };
 
} // namespace OpenMS