Exception.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/CONCEPT/Types.h>
#include <OpenMS/OpenMSConfig.h>
#include <iosfwd>
#include <stdexcept>
#include <string>
 
namespace OpenMS
{
 
  namespace Exception
  {
 
    class OPENMS_DLLAPI BaseException : public std::runtime_error
    {
    public:
 
      BaseException() noexcept;
 
      BaseException(const char* file, int line, const char* function) noexcept;
 
      BaseException(const char* file, int line, const char* function, const std::string& name, const std::string& message) noexcept;
 
      BaseException(const BaseException& exception) noexcept;
 
      ~BaseException() noexcept override;
 
 
      const char* getName() const noexcept;
 
      int getLine() const noexcept;
 
      const char* getFile() const noexcept;
 
      const char* getFunction() const noexcept;
 
      const char* getMessage() const noexcept;
 
 
    protected:
      const char* file_;
 
      int line_;
 
      const char* function_;
 
      std::string name_;
    };
 
    class OPENMS_DLLAPI Precondition : public BaseException
    {
    public:
      Precondition(const char* file, int line, const char* function, const std::string& condition) noexcept;
    };
 
    class OPENMS_DLLAPI Postcondition : public BaseException
    {
    public:
      Postcondition(const char* file, int line, const char* function, const std::string& condition) noexcept;
    };
 
    class OPENMS_DLLAPI MissingInformation : public BaseException
    {
    public:
      MissingInformation(const char* file, int line, const char* function, const std::string& error_message) noexcept;
    };
 
 
    class OPENMS_DLLAPI IndexUnderflow : public BaseException
    {
    public:
      IndexUnderflow(const char* file, int line, const char* function, SignedSize index = 0, Size size = 0) noexcept;
    };
 
    class OPENMS_DLLAPI SizeUnderflow : public BaseException
    {
    public:
      SizeUnderflow(const char* file, int line, const char* function, Size size = 0) noexcept;
    };
 
    class OPENMS_DLLAPI IndexOverflow : public BaseException
    {
    public:
      IndexOverflow(const char* file, int line, const char* function, SignedSize index = 0, Size size = 0) noexcept;
    };
 
 
    class OPENMS_DLLAPI NotSorted : public BaseException
    {
    public:
      NotSorted(const char* file, int line, const char* function, const std::string& message) noexcept;
    };
 
    class OPENMS_DLLAPI FailedAPICall : public BaseException
    {
    public:
      FailedAPICall(const char* file, int line, const char* function, const std::string& message) noexcept;
    };
 
    class OPENMS_DLLAPI InvalidRange : public BaseException
    {
    public:
      InvalidRange(const char* file, int line, const char* function) noexcept;
      InvalidRange(const char* file, int line, const char* function, const std::string& message) noexcept;
    };
 
 
    class OPENMS_DLLAPI InvalidSize : public BaseException
    {
    public:
      InvalidSize(const char* file, int line, const char* function, Size size, const std::string& message) noexcept;
    };
 
 
    class OPENMS_DLLAPI OutOfRange : public BaseException
    {
    public:
      OutOfRange(const char* file, int line, const char* function) noexcept;
    };
 
    class OPENMS_DLLAPI InvalidValue : public BaseException
    {
    public:
      InvalidValue(const char* file, int line, const char* function, const std::string& message, const std::string& value) noexcept;
    };
 
    class OPENMS_DLLAPI InvalidParameter : public BaseException
    {
    public:
      InvalidParameter(const char* file, int line, const char* function, const std::string& message) noexcept;
    };
 
    class OPENMS_DLLAPI ConversionError : public BaseException
    {
    public:
      ConversionError(const char* file, int line, const char* function, const std::string& error) noexcept;
    };
 
    class OPENMS_DLLAPI IllegalSelfOperation : public BaseException
    {
    public:
      IllegalSelfOperation(const char* file, int line, const char* function) noexcept;
    };
 
    class OPENMS_DLLAPI NullPointer : public BaseException
    {
    public:
      NullPointer(const char* file, int line, const char* function) noexcept;
    };
 
    class OPENMS_DLLAPI InvalidIterator : public BaseException
    {
    public:
      InvalidIterator(const char* file, int line, const char* function) noexcept;
    };
 
    class OPENMS_DLLAPI IncompatibleIterators : public BaseException
    {
    public:
      IncompatibleIterators(const char* file, int line, const char* function) noexcept;
    };
 
    class OPENMS_DLLAPI NotImplemented : public BaseException
    {
    public:
      NotImplemented(const char* file, int line, const char* function) noexcept;
    };
 
    class OPENMS_DLLAPI IllegalTreeOperation : public BaseException
    {
    public:
      IllegalTreeOperation(const char* file, int line, const char* function) noexcept;
    };
 
    class OPENMS_DLLAPI OutOfMemory : public BaseException, public std::bad_alloc
    {
    public:
      OutOfMemory(const char* file, int line, const char* function, Size size = 0) noexcept;
    };
 
    class OPENMS_DLLAPI BufferOverflow : public BaseException
    {
    public:
      BufferOverflow(const char* file, int line, const char* function) noexcept;
    };
 
    class OPENMS_DLLAPI DivisionByZero : public BaseException
    {
    public:
      DivisionByZero(const char* file, int line, const char* function) noexcept;
    };
 
    class OPENMS_DLLAPI OutOfGrid : public BaseException
    {
    public:
      OutOfGrid(const char* file, int line, const char* function) noexcept;
    };
 
    class OPENMS_DLLAPI FileNotFound : public BaseException
    {
    public:
      FileNotFound(const char* file, int line, const char* function, const std::string& filename) noexcept;
    };
 
    class OPENMS_DLLAPI ExternalExecutableNotFound : public BaseException
    {
    public:
      ExternalExecutableNotFound(const char* file, int line, const char* function, const std::string& filename) noexcept;
    };
 
    class OPENMS_DLLAPI FileNotReadable : public BaseException
    {
    public:
      FileNotReadable(const char* file, int line, const char* function, const std::string& filename) noexcept;
    };
 
    class OPENMS_DLLAPI FileNotWritable : public BaseException
    {
    public:
      FileNotWritable(const char* file, int line, const char* function, const std::string& filename) noexcept;
    };
 
    class OPENMS_DLLAPI FileNameTooLong : public BaseException
    {
    public:
      FileNameTooLong(const char* file, int line, const char* function, const std::string& filename, int max_length) noexcept;
    };
 
    class OPENMS_DLLAPI IOException : public BaseException
    {
    public:
      IOException(const char* file, int line, const char* function, const std::string& filename) noexcept;
    };
 
    class OPENMS_DLLAPI SqlOperationFailed : public BaseException
    {
    public:
      SqlOperationFailed(const char* file, int line, const char* function, const std::string& description) noexcept;
    };
 
    class OPENMS_DLLAPI FileEmpty : public BaseException
    {
    public:
      FileEmpty(const char* file, int line, const char* function, const std::string& filename) noexcept;
    };
 
    class OPENMS_DLLAPI IllegalPosition : public BaseException
    {
    public:
      IllegalPosition(const char* file, int line, const char* function, float x, float y, float z) noexcept;
    };
 
    class OPENMS_DLLAPI ParseError : public BaseException
    {
    public:
      ParseError(const char* file, int line, const char* function, const std::string& expression, const std::string& message) noexcept;
    };
 
    class OPENMS_DLLAPI UnableToCreateFile : public BaseException
    {
    public:
      UnableToCreateFile(const char* file, int line, const char* function, const std::string& filename, const std::string& message = "") noexcept;
    };
 
    class OPENMS_DLLAPI InvalidFileType : public BaseException
    {
    public:
      InvalidFileType(const char* file, int line, const char* function, const std::string& filename, const std::string& message = "") noexcept;
    };
 
    class OPENMS_DLLAPI IllegalArgument : public BaseException
    {
    public:
      IllegalArgument(const char* file, int line, const char* function, const std::string& error_message) noexcept;
    };
 
    class OPENMS_DLLAPI InternalToolError : public BaseException
    {
    public:
      InternalToolError(const char* file, int line, const char* function, const std::string& error_message) noexcept;
    };
 
    class OPENMS_DLLAPI ElementNotFound : public BaseException
    {
    public:
      ElementNotFound(const char* file, int line, const char* function, const std::string& element) noexcept;
    };
 
    class OPENMS_DLLAPI UnableToFit : public BaseException
    {
    public:
      UnableToFit(const char* file, int line, const char* function, const std::string& name, const std::string& message) noexcept;
    };
 
    class OPENMS_DLLAPI UnableToCalibrate : public BaseException
    {
    public:
      UnableToCalibrate(const char* file, int line, const char* function, const std::string& name, const std::string& message) noexcept;
    };
 
    class OPENMS_DLLAPI DepletedIDPool : public BaseException
    {
    public:
      DepletedIDPool(const char* file, int line, const char* function, const std::string& name, const std::string& message) noexcept;
    };
 
  } // namespace Exception
 
  OPENMS_DLLAPI std::ostream& operator<<(std::ostream& os, const Exception::BaseException& e);
 
} // namespace OpenMS