WareException.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 WareException.hpp
 
  @author Jean-Christophe FABRE <jean-christophe.fabre@inra.fr>
 */
 
 
#ifndef __OPENFLUID_WARE_WAREEXCEPTION_HPP__
#define __OPENFLUID_WARE_WAREEXCEPTION_HPP__
 
 
#include <sstream>
 
#include <openfluid/base/Exception.hpp>
#include <openfluid/base/SimulationStatus.hpp>
#include <openfluid/ware/WareSignature.hpp>
#include <openfluid/ware/PluggableWare.hpp>
#include <openfluid/dllexport.hpp>
 
 
namespace openfluid { namespace ware {
 
 
class OPENFLUID_API WareException : public openfluid::base::Exception
{
  protected:
 
 
    void buildFullMessage()
    {
      m_FullMessage = m_Message;
      m_FullMessage += " [" + m_Context.toString() + "]";
    }
 
 
  public:
 
    WareException() = delete;
 
    WareException(const openfluid::base::ExceptionContext& Context,
                  const std::string& Msg) :
      openfluid::base::Exception(Context,Msg)
    {
      buildFullMessage();
    }
 
 
    // =====================================================================
    // =====================================================================
 
 
    static openfluid::base::ExceptionContext computeContext(const WareType WType,
                                                            const WareID_t& ID)
    {
 
      openfluid::base::ExceptionContext Context;
 
      Context["source"] = "ware";
      Context["waretype"] = "unknown";
 
      if (WType == WareType::OBSERVER)
      {
        Context["waretype"] = "observer";
      }
      else if (WType == WareType::SIMULATOR)
      {
        Context["waretype"] = "simulator";
      }
 
      Context["wareid"] = ID;
 
      return Context;
    }
 
 
    // =====================================================================
    // =====================================================================
 
 
    static openfluid::base::ExceptionContext computeContext(const WareType WType,
                                                            const WareID_t& ID,
                                                            const openfluid::base::SimulationStatus::SimulationStage
                                                              Stage)
    {
      
      openfluid::base::ExceptionContext Context = computeContext(WType,ID);
 
      Context.addStage(openfluid::base::SimulationStatus::getStageAsString(Stage));
      
      return Context;
    }
 
 
    // =====================================================================
    // =====================================================================
 
 
    static openfluid::base::ExceptionContext computeContext(const WareType WType,
                                                            const WareID_t& ID,
                                                            const openfluid::base::SimulationStatus::SimulationStage
                                                              Stage,
                                                            openfluid::core::TimeIndex_t TimeIndex)
    {
      openfluid::base::ExceptionContext Context = computeContext(WType,ID,Stage);
 
      Context.addTimeIndex(TimeIndex);
 
      return Context;
    }
 
 
};
 
 
} } // namespaces
 
 
#endif /* __OPENFLUID_WARE_WAREEXCEPTION_HPP__ */