Exception.hpp

Go to the documentation of this file.

/*
 
  This file is part of OpenFLUID software
  Copyright(c) 2021-2026, INRAE
 
 
 == GNU General Public License Usage ==
 
  OpenFLUID is free software: you can redistribute it and/or modify
  it under the terms of the GNU General Public License as published by
  the Free Software Foundation, either version 3 of the License, or
  (at your option) any later version.
 
  OpenFLUID 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 for more details.
 
  You should have received a copy of the GNU General Public License
  along with OpenFLUID. If not, see <http://www.gnu.org/licenses/>.
 
 
 == Other Usage ==
 
  Other Usage means a use of OpenFLUID that is inconsistent with the GPL
  license, and requires a written agreement between You and INRA.
  Licensees for Other Usage of OpenFLUID may use this file in accordance
  with the terms contained in the written agreement between You and INRA.
  
*/
 
 
/**
  @file Exception.hpp
 
  @author Jean-Christophe FABRE <jean-christophe.fabre@inra.fr>
*/
 
 
#ifndef __OPENFLUID_BASE_EXCEPTION_HPP__
#define __OPENFLUID_BASE_EXCEPTION_HPP__
 
 
#include <exception>
 
#include <openfluid/base/ExceptionContext.hpp>
 
 
namespace openfluid { namespace base {
 
 
class Exception : public std::exception
{
  protected:
 
      std::string m_Message;
 
      ExceptionContext m_Context;
 
      std::string m_FullMessage;
 
 
      virtual void buildFullMessage() = 0;
 
 
      Exception(const std::string& Msg) :
        m_Message(Msg), m_FullMessage("")
      { }
 
      Exception(const ExceptionContext& Context, const std::string& Msg) :
        m_Message(Msg), m_Context(Context), m_FullMessage("")
      { }
 
 
  public:
 
    Exception() = delete;
 
    virtual ~Exception() throw()
    { }
 
 
    // =====================================================================
    // =====================================================================
 
 
    const char * what() const throw()
    {
#ifdef NDEBUG
      return m_Message.c_str();
#else
      return m_FullMessage.c_str();
#endif
    }
 
 
    // =====================================================================
    // =====================================================================
 
 
    const std::string getMessage() const
    {
      return m_Message;
    }
 
 
    // =====================================================================
    // =====================================================================
 
 
    const std::string getFullMessage() const
    {
      return m_FullMessage;
    }
 
 
    // =====================================================================
    // =====================================================================
 
 
    const ExceptionContext getContext() const
    {
      return m_Context;
    }
 
};
 
 
} } // namespace
 
#endif /* __OPENFLUID_BASE_EXCEPTION_HPP__ */