TOPPBase_defs.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/APPLICATIONS/OpenMS_CLIConfig.h>
 
// Small, dependency-light definitions shared by TOPPBase: the Citation struct and
// the TOPPBase-specific parameter exceptions. Split out of TOPPBase.h so they can
// be used without pulling in the full TOPPBase interface.
 
#include <OpenMS/CONCEPT/Exception.h>
#include <OpenMS/CONCEPT/GlobalExceptionHandler.h>
 
#include <string>
 
namespace OpenMS
{
  struct Citation
  {
    std::string authors;    
    std::string title;      
    std::string when_where; 
    std::string doi;        
 
    std::string toString() const
    {
      return authors + ". " + title + ". " + when_where + ". doi:" + doi + ".";
    }
  };
 
  namespace Exception
  {
    class OPENMS_CLI_DLLAPI UnregisteredParameter :
      public Exception::BaseException
    {
public:
      UnregisteredParameter(const char* file, int line, const char* function, const std::string& parameter) :
        BaseException(file, line, function, "UnregisteredParameter", parameter)
      {
        GlobalExceptionHandler::getInstance().setMessage(what());
      }
 
    };
    class OPENMS_CLI_DLLAPI WrongParameterType :
      public Exception::BaseException
    {
public:
      WrongParameterType(const char* file, int line, const char* function, const std::string& parameter) :
        BaseException(file, line, function, "WrongParameterType", parameter)
      {
        GlobalExceptionHandler::getInstance().setMessage(what());
      }
 
    };
    class OPENMS_CLI_DLLAPI RequiredParameterNotGiven :
      public Exception::BaseException
    {
public:
      RequiredParameterNotGiven(const char* file, int line, const char* function, const std::string& parameter) :
        BaseException(file, line, function, "RequiredParameterNotGiven", parameter)
      {
        GlobalExceptionHandler::getInstance().setMessage(what());
      }
 
    };
  }
 
} // namespace OpenMS