ParamCTDFile.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: Ruben Grünberg $
// $Authors: Ruben Grünberg $
// --------------------------------------------------------------------------
 
#pragma once
 
#include <string>
#include <OpenMS/DATASTRUCTURES/Param.h>
 
namespace OpenMS
{
 
  struct ToolInfo
  {
    std::string version_;
    std::string name_;
    std::string docurl_;
    std::string category_;
    std::string description_;
    std::vector<std::string> citations_;
  };
 
  class OPENMS_DLLAPI ParamCTDFile
  {
  public:
    ParamCTDFile() = default; 
    
    ~ParamCTDFile() = default; 
 
    void store(const std::string& filename, const Param& param, const ToolInfo& tool_info) const;
 
    void writeCTDToStream(std::ostream* os_ptr, const Param& param, const ToolInfo& tool_info) const;
 
  private:
    static std::string escapeXML(const std::string& to_escape);
 
    static void replace(std::string& replace_in, char to_replace, const std::string& replace_with);
 
    const std::string schema_location_ = "/SCHEMAS/Param_1_8_0.xsd";
    const std::string schema_version_ = "1.8.0";
  };
}