ParameterInformation.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, Clemens Groepl $
// --------------------------------------------------------------------------
 
#pragma once
 
#include <OpenMS/DATASTRUCTURES/StringUtils.h>
#include <OpenMS/DATASTRUCTURES/StringListUtils.h>
#include <OpenMS/DATASTRUCTURES/ParamValue.h>
 
namespace OpenMS
{
 
  struct OPENMS_DLLAPI ParameterInformation
  {
    enum ParameterTypes
    {
      NONE = 0, 
      STRING, 
      INPUT_FILE, 
      OUTPUT_FILE, 
      OUTPUT_PREFIX, 
      OUTPUT_DIR, 
      DOUBLE, 
      INT, 
      STRINGLIST, 
      INTLIST, 
      DOUBLELIST, 
      INPUT_FILE_LIST, 
      OUTPUT_FILE_LIST, 
      FLAG, 
      TEXT, 
      NEWLINE 
    };
 
    std::string name;
    ParameterTypes type;
    ParamValue default_value;
    std::string description;
    std::string argument;
    bool required;
    bool advanced;
    StringList tags;
 
 
    StringList valid_strings;
    Int min_int;
    Int max_int;
    double min_float;
    double max_float;
 
    ParameterInformation(const std::string& n, ParameterTypes t, const std::string& arg, const ParamValue& def, const std::string& desc, bool req, bool adv, const StringList& tag_values = StringList());
 
    ParameterInformation();
 
    ParameterInformation(const ParameterInformation& rhs) = default;
 
    ParameterInformation& operator=(const ParameterInformation& rhs);
 
  };
 
} // namespace