core-exceptions.hpp

Go to the documentation of this file.

/*
Copyright (c) 2017-2026,
Battelle Memorial Institute; Lawrence Livermore National Security, LLC; Alliance for Energy
Innovation LLC.  See the top-level NOTICE for additional details. All rights reserved.
SPDX-License-Identifier: BSD-3-Clause
*/
#pragma once
#include <stdexcept>
#include <string>
#include <string_view>
 
namespace helics {
class HelicsException: public std::exception {
  private:
    std::string errorMessage = "HELICS EXCEPTION";
 
  public:
    HelicsException() = default;
    explicit HelicsException(std::string_view message) noexcept: errorMessage(message) {}
    virtual const char* what() const noexcept override { return errorMessage.c_str(); }
};
 
class FunctionExecutionFailure: public HelicsException {
  public:
    explicit FunctionExecutionFailure(
        std::string_view message = "HELICS execution failure") noexcept: HelicsException(message)
    {
    }
};
 
class InvalidIdentifier: public HelicsException {
  public:
    explicit InvalidIdentifier(std::string_view message = "invalid identifier") noexcept:
        HelicsException(message)
    {
    }
};
 
class InvalidParameter: public HelicsException {
  public:
    explicit InvalidParameter(std::string_view message = "invalid parameter") noexcept:
        HelicsException(message)
    {
    }
};
 
class InvalidConversion: public HelicsException {
  public:
    explicit InvalidConversion(
        std::string_view message = "unable to perform the requested conversion") noexcept:
        HelicsException(message)
    {
    }
};
 
class InvalidFunctionCall: public HelicsException {
  public:
    explicit InvalidFunctionCall(std::string_view message = "invalid function call") noexcept:
        HelicsException(message)
    {
    }
};
 
class ConnectionFailure: public HelicsException {
  public:
    explicit ConnectionFailure(std::string_view message = "failed to connect") noexcept:
        HelicsException(message)
    {
    }
};
 
class RegistrationFailure: public HelicsException {
  public:
    explicit RegistrationFailure(std::string_view message = "registration failure") noexcept:
        HelicsException(message)
    {
    }
};
 
class HelicsSystemFailure: public HelicsException {
  public:
    explicit HelicsSystemFailure(std::string_view message = "HELICS system failure") noexcept:
        HelicsException(message)
    {
    }
};
 
class FederateError: public HelicsException {
  public:
    int code{0};
    FederateError(int errorCode, std::string_view message) noexcept:
        HelicsException(message), code(errorCode)
    {
    }
};
}  // namespace helics