OutOfRangeMsg.hpp

/* Copyright 2017-2025 Axel Huebl, Fabian Koller
 *
 * This file is part of openPMD-api.
 *
 * openPMD-api is free software: you can redistribute it and/or modify
 * it under the terms of of either the GNU General Public License or
 * the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * openPMD-api is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License and the GNU Lesser General Public License
 * for more details.
 *
 * You should have received a copy of the GNU General Public License
 * and the GNU Lesser General Public License along with openPMD-api.
 * If not, see <http://www.gnu.org/licenses/>.
 */
#pragma once
 
#include <string>
#include <type_traits>
 
namespace openPMD
{
namespace auxiliary
{

    class OutOfRangeMsg
    {
        std::string m_name;
        std::string m_description;
 
    public:
        OutOfRangeMsg()
            : m_name("Key"), m_description("does not exist (read-only).")
        {}
        OutOfRangeMsg(std::string const name, std::string const description)
            : m_name(name), m_description(description)
        {}
 
        template <
            typename T_Key,
            typename = typename std::enable_if<
                std::is_integral<T_Key>::value ||
                std::is_floating_point<T_Key>::value>::type>
        std::string operator()(T_Key const key) const
        {
            return m_name + std::string(" '") + std::to_string(key) +
                std::string("' ") + m_description;
        }
 
        std::string operator()(std::string const key) const
        {
            return m_name + std::string(" '") + std::string(key) +
                std::string("' ") + m_description;
        }
 
        std::string operator()(...) const
        {
            return m_name + std::string(" ") + m_description;
        }
    };
 
} // namespace auxiliary
} // namespace openPMD