Error.hpp

#pragma once

#include <exception>
#include <string>
#include <utility>
#include <vector>

namespace openPMD
{
/**
 * @brief Base class for all openPMD-specific error types.
 *
 * Should not be instantiated directly, but only by implementing child classes
 * in the openPMD::error namespace.
 *
 */
class Error : public std::exception
{
private:
    std::string m_what;

protected:
    Error( std::string what ) : m_what( what )
    {
    }

public:
    virtual const char * what() const noexcept;

    Error( Error const & ) = default;
    Error( Error && ) = default;

    Error & operator=( Error const & ) = default;
    Error & operator=( Error && ) = default;

    virtual ~Error() noexcept = default;
};

namespace error
{
    /**
     * @brief An operation was requested that is not supported in a specific
     *     backend.
     *
     * Example: Append mode is not available in ADIOS1.
     */
    class OperationUnsupportedInBackend : public Error
    {
    public:
        std::string backend;
        OperationUnsupportedInBackend(
            std::string backend_in, std::string what );
    };

    /**
     * @brief The API was used in an illegal way.
     *
     * Example: File-based iteration encoding is selected without specifying an
     *     expansion pattern.
     */
    class WrongAPIUsage : public Error
    {
    public:
        WrongAPIUsage( std::string what );
    };

    class BackendConfigSchema : public Error
    {
    public:
        std::vector< std::string > errorLocation;

        BackendConfigSchema( std::vector< std::string >, std::string what );
    };
}
}