FMTException.h

Go to the documentation of this file.

/*
Copyright (c) 2019 Gouvernement du Québec
 
SPDX-License-Identifier: LiLiQ-R-1.1
License-Filename: LICENSES/EN/LiLiQ-R11unicode.txt
*/
    
 
 
#ifndef FMTEXCEPTION_Hm_included
#define FMTEXCEPTION_Hm_included
 
#include <exception>
#include <string>
#include <iostream>
#include <memory>
#include "FMTutility.h"
#include <boost/serialization/access.hpp>
#include <boost/serialization/base_object.hpp>
#include <boost/serialization/string.hpp>
 
 
 
namespace Exception
{
// DocString: FMTlev
enum FMTlev
    {
    FMT_None=0,
    FMT_Debug=1,
    FMT_Warning=2,
    FMT_logic=3,
    FMT_range=4
    };
 
// DocString: FMTexc
enum FMTexc
{
    None = 0,
    FMTconstants_replacement = 1,
    FMTcomma_replacement = 2,
    FMTfutur_types = 3,
    FMTinvalid_theme = 5,
    FMTinvalid_aggregate = 6,
    FMTinvalid_maskrange = 7,
    FMTinvalid_yield = 8,
    FMTinvalid_action = 9,
    FMTinvalid_transition = 10,
    FMTinvalid_transition_case = 11,
    FMTinvalid_number = 12,
    FMTinvalid_path = 13,
    FMTtheme_redefinition = 14,
    FMTaggregate_redefinition = 15,
    FMTempty_theme = 16,
    FMTempty_aggregate = 17,
    FMTundefined_aggregate_value = 18,
    FMTundefined_attribute = 19,
    FMTempty_action = 20,
    FMTwrong_partial = 21,
    FMTpreexisting_yield = 22,
    FMTunsupported_yield = 23,
    FMTinvaliddataset = 24,
    FMTinvalidband = 25,
    FMTinvalidrasterblock = 26,
    FMTinvalidlayer = 27,
    FMTmissingfield = 28,
    FMTinvalidoverview = 29,
    FMTmissingrasterattribute = 30,
    FMTunsupported_transition = 31,
    FMTundefined_action = 32,
    FMTempty_transition = 33,
    FMTundefined_output = 34,
    FMTunsupported_output = 35,
    FMTinvaliddriver = 36,
    FMTinvalidAandT = 37,
    FMTleakingtransition = 38,
    FMTundefineddeathaction = 39,
    FMTundefineddeathtransition = 40,
    FMTignore = 41,
    FMTmissingyield = 42,
    FMTattribute_redefinition = 43,
    FMTundefined_constant = 44,
    FMTmissingdevelopment = 45,
    FMTmissingobjective = 46,
    FMTunsupported_objective = 47,
    FMTinvalid_constraint = 48,
    FMTemptybound = 49,
    FMTunboundedperiod = 50,
    FMTnonaddedconstraint = 51,
    FMTmissinglicense = 52,
    FMTfunctionfailed = 53,
    FMTcoinerror = 54,
    FMTboostgrapherror = 55,
    FMTunhandlederror = 56,
    FMTnotlinegraph = 57,
    FMTrangeerror = 58,
    FMTGDALerror = 59,
    FMTGDALwarning = 60,
    FMTinfeasibleconstraint = 61,
    FMTthematic_output_diff = 62,
    FMToutput_missing_operator = 63,
    FMToutput_too_much_operator = 64,
    FMTinvalidyield_number = 65,
    FMTgdal_constructor_error = 66,
    FMTinvalid_geometry = 67,
    FMTundefinedoutput_attribute = 68,
    FMTempty_schedules = 69,
    FMTmissing_scenarios = 70,
    FMTschemefailed = 71,
    FMTmskerror = 73,
    FMToveridedyield = 74,
    FMTmissing_parameter = 75,
    FMTdeathwithlock = 76,
    FMTreplanningwarning = 77,
    FMTyieldmodelprediction = 78,
    FMTsourcetotarget_transition = 79,
    FMTsame_transitiontargets = 80,
    FMTunclosedforloop = 81,
    FMTthreadcrash = 82,
    FMToutofrangeyield = 83,
    FMTEmpty_OA = 84,
    FMTWIN32_Error = 85,
    FMTMSKnumerical_problem = 86,
    FMTunreachable_threshold = 87,
    FMTmaxnumberofexception = 88
};
 
// DocString: FMTException
class FMTEXPORT FMTException : public std::exception
    {
    public:
        // DocString: FMTException()
        FMTException();
        // DocString: ~FMTException()
        virtual ~FMTException() = default;
        // DocString: FMTException(FMTexc,FMTlev,Core::FMTsection,const std::string&,const std::string&,const std::string&,const std::string&,const std::string&,const std::string&)
        FMTException(FMTexc p_exception, FMTlev p_level,Core::FMTsection p_section,const std::string& p_message,
            const std::string& p_method, const std::string& p_file, const int& p_line,
            const std::string& p_FrenchDescription, const std::string& p_EnglishDescription);
        // DocString: FMTException(const FMTException&)
        FMTException(const FMTException& rhs)=default;
        // DocString: FMTException::operator=
        FMTException& operator = (const FMTException& rhs)=default;
        // DocString: FMTException::getType
        FMTexc getType() const;
        // DocString: FMTException::getSection
        Core::FMTsection getSection() const;
        // DocString: FMTException::what
        const char* what() const noexcept override;
        // DocString: FMTException::hold
        bool hold() const;
        // DocString: FMTException::setHold
        void setHold(bool side);
        // DocString: FMTException::getMethod
        inline std::string getMethod() const
            {
            return m_method;
            }
        // DocString: FMTException::getFile
        inline std::string getFile() const
            {
            return m_file;
            }
        // DocString: FMTException::getLine
        inline int getLine() const
            {
            return m_line;
            }
        // DocString: FMTException::getDescription(bool)
        const std::string& getDescription(bool p_french=false) const;
        // DocString: FMTException::getSrcInfo
        std::string getSrcInfo() const;
        // DocString: FMTException::getMessage
        const std::string& getMessage() const;
        // DocString: FMTException::getLevel
        FMTlev getLevel() const;
        // DocString: FMTException::isFatal
        bool isFatal() const;
        // DocString: FMTException::setIgnore
        void setIgnore();
        // DocString: FMTException::setPrintLevel
        void setPrintLevel(int p_level);
    private:
        // DocString: FMTException::_getPrintLevel
        int _getPrintLevel() const;
        // DocString: FMTException::_getUserMessage
        const std::string& _getUserMessage() const;
        // DocString: FMTException::_buildMessage
        void _buildMessage();
        // DocString: FMTException::serialize
        friend class boost::serialization::access;
        template<class Archive>
        void serialize(Archive& ar, const unsigned int version);
        // DocString: FMTException::m_holdup
        bool m_holdup;
        // DocString: FMTException::_msg
        std::string m_msg;
        // DocString: FMTException::m_exceptiontype
        FMTexc m_exceptiontype;
        // DocString: FMTException::m_section
        Core::FMTsection m_section;
        // DocString: FMTException::m_method
        std::string m_method;
        // DocString: FMTException::m_file
        std::string m_file;
        // DocString: FMTException::m_line
        int m_line;
        // DocString: FMTException::m_FrenchDescription 
        std::string m_FrenchDescription;
        // DocString: FMTException::m_EnglishDescription 
        std::string m_EnglishDescription;
        // DocString: FMTException::m_level
        FMTlev m_level;
        // DocString: FMTException::m_PrintLevel
        int m_PrintLevel;
        // DocString: FMTException::m_UserMessage 
        std::string m_UserMessage;
    };
 
}
 
 
#endif // FMTEXCEPTION_Hm_included