ls-standard-library/include/ls-std/core/exception/IllegalArithmeticOperationException.hpp

/*
 * Author:          Patrick-Christopher Mattulat
 * Company:         Lynar Studios
 * E-Mail:          webmaster@lynarstudios.com
 * Created:         2020-08-07
 * Changed:         2024-09-11
 *
 * */

#ifndef LS_STD_ILLEGAL_ARITHMETIC_OPERATION_EXCEPTION_HPP
#define LS_STD_ILLEGAL_ARITHMETIC_OPERATION_EXCEPTION_HPP

#include <ls-std/core/exception/Exception.hpp>
#include <ls-std/os/dynamic-goal.hpp>
#include <string>

/*
 * @doc: class(name: 'IllegalArithmeticOperationException', package: 'core')
 * @doc: core.IllegalArithmeticOperationException.description('This exception can be thrown in case an arithmetic operation is illegal. One example would be the division by zero.')
 * */

namespace ls::std::core
{
  class LS_STD_DYNAMIC_GOAL IllegalArithmeticOperationException : public ls::std::core::Exception
  {
    public:

      IllegalArithmeticOperationException();
      explicit IllegalArithmeticOperationException(const ::std::string &_message);
      ~IllegalArithmeticOperationException() noexcept override;

      [[nodiscard]] const char *what() const noexcept override;
  };
}

#endif