Exception.hpp

Go to the documentation of this file.

/*--------------------------------------------------------------------------------------------
Copyright (c) 2019, NDEVR LLC
tyler.parke@ndevr.org
  __    __   ____     _____ __     __  _______
 |  \  |  | |  __ \  |  ___|\ \   / / |   __  \
 |   \ |  | | |  \ \ | |___  \ \ / /  |  |__)  |
 |  . \|  | | |__/ / | |___   \ V /   |   _   /
 |  |\    |_|_____/__|_____|___\_/____|  | \  \
 |__| \__________________________________|  \__\
 
Subject to the terms of the Enterprise+ Agreement, NDEVR hereby grants 
Licensee a limited, non-exclusive, non-transferable, royalty-free license 
(without the right to sublicense) to use the API solely for the purpose of 
Licensee's internal development efforts to develop applications for which 
the API was provided.
 
The above copyright notice and this permission notice shall be included in all 
copies or substantial portions of the Software.
 
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.
 
Library: Base
File: Exception
Included in API: True
Author(s): Tyler Parke
 *-----------------------------------------------------------------------------------------**/
#pragma once
#include "DLLInfo.h"
#include <NDEVR/BaseValues.h>
#include <NDEVR/String.h>
#include <NDEVR/TranslatedString.h>
#include <exception>
namespace NDEVR
{
    /**--------------------------------------------------------------------------------------------------
    Class: Exception
    
    \brief Provides consistent interface to handle errors through the throw expression.
        All exceptions generated by the Parke library inherit from Exception
    
    Author: Tyler Parke
    
    Date: 2017-11-17
     *-----------------------------------------------------------------------------------------------**/
    class UUID;
    class Exception
    {
    public:
        virtual ~Exception() = default;
 
        /**--------------------------------------------------------------------------------------------------
                Constructor. 
        
        Author: Tyler Parke
        
        Date: 2017-11-17
        
        Parameters:
        message -  The message that identifies the exception.
         *-----------------------------------------------------------------------------------------------**/
        //NDEVR_BASE_API explicit Exception(const bool& capture_stack = true);
        //explicit Exception(const String& message);
 
        NDEVR_BASE_API Exception(const String& title, const bool& capture_stack = true);
        NDEVR_BASE_API Exception(const TranslatedString& title, const bool& capture_stack = true);
        NDEVR_BASE_API Exception(const std::exception& exception);
        NDEVR_BASE_API Exception(const TranslatedString& title, const TranslatedString& message, const bool& capture_stack = true);
        /**--------------------------------------------------------------------------------------------------
                Sets a title for the exception.
        
        Author: Tyler Parke
        
        Date: 2018-07-09
        
        Parameters:
        title -  The title of the exception.
         *-----------------------------------------------------------------------------------------------**/
        void setTitle(const TranslatedString& title)
        {
            m_title = title;
        }
        virtual void setMessage(const TranslatedString& message)
        {
            m_message = message;
        }
 
        
 
        /**--------------------------------------------------------------------------------------------------
                Sets a message.
 
        Author: Tyler Parke
 
        Date: 2017-11-17
 
        Parameters:
        message -  The message.
        *-----------------------------------------------------------------------------------------------**/
 
        void setCategory(const TranslatedString& category)
        {
            m_category = category;
        }
        void setThread(const String& thread)
        {
            m_thread = thread;
        }
        /**--------------------------------------------------------------------------------------------------
                Gets the message identifying the exception
 
        Author: Tyler Parke
 
        Date: 2017-11-17
 
        Returns: Null if it fails, else the message.
        *-----------------------------------------------------------------------------------------------**/
 
        virtual TranslatedString getMessage() const
        { 
            return m_message; 
        }
        virtual const TranslatedString& getTitle() const
        {
            return m_title;
        }
        virtual const TranslatedString& getCategory() const
        {
            return m_category;
        }
        virtual const String& stackTrace() const 
        { 
            return m_stack_trace;
        }
        virtual uint04 getPriority() const
        {
            return m_priority;
        }
        
        const String& thread() const
        {
            return m_thread;
        }
        NDEVR_BASE_API UUID id() const;
        void printToLogger();
    protected:
        TranslatedString m_message;
        TranslatedString m_title;
        TranslatedString m_category;
        String m_thread;
        String m_stack_trace;
        uint04 m_priority;
    };
 
};