DefaultParamHandler.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 $
// --------------------------------------------------------------------------
 
#pragma once
 
#include <OpenMS/DATASTRUCTURES/Param.h>
#include <OpenMS/DATASTRUCTURES/StringUtils.h>
#include <OpenMS/OpenMSConfig.h>
#include <vector>
 
namespace OpenMS
{
  class MetaInfoInterface;
  class OPENMS_DLLAPI DefaultParamHandler
  {
  public:
    DefaultParamHandler(const std::string& name);
 
    DefaultParamHandler(const DefaultParamHandler& rhs);
 
    virtual ~DefaultParamHandler();
 
    DefaultParamHandler& operator=(const DefaultParamHandler& rhs);
 
    virtual bool operator==(const DefaultParamHandler& rhs) const;
 
    void setParameters(const Param& param);
 
    const Param& getParameters() const;
 
    const Param& getDefaults() const;
 
    const std::string& getName() const;
 
    void setName(const std::string& name);
 
    const std::vector<std::string>& getSubsections() const;
 
    static void writeParametersToMetaValues(const Param& write_this, MetaInfoInterface& write_here, const std::string& key_prefix = "");
 
  protected:
    virtual void updateMembers_();
 
    void defaultsToParam_();
 
    Param param_;
 
    Param defaults_;
 
    std::vector<std::string> subsections_;
 
    std::string error_name_;
 
    bool check_defaults_;
 
    bool warn_empty_defaults_;
 
  private:
    DefaultParamHandler();
 
  }; // class
 
} // namespace OpenMS