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 UUID;
    /**--------------------------------------------------------------------------------------------------
    \brief Provides consistent interface to handle errors through the throw expression.
        All exceptions generated by the Parke library inherit from Exception
    **/
    class Exception
    {
    public:
        virtual ~Exception() = default;
        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);
        void setTitle(const TranslatedString& title)
        {
            m_title = title;
        }
        void setTitle(const TranslatedString& title) {…}
        virtual void setMessage(const TranslatedString& message)
        {
            m_message = message;
        }
        virtual void setMessage(const TranslatedString& message) {…}
        void setCategory(const TranslatedString& category)
        {
            m_category = category;
        }
        void setCategory(const TranslatedString& category) {…}
        void setThread(const String& thread)
        {
            m_thread = thread;
        }
        void setThread(const String& thread) {…}
 
        virtual TranslatedString getMessage() const
        { 
            return m_message; 
        }
        virtual TranslatedString getMessage() const {…}
        virtual const TranslatedString& getTitle() const
        {
            return m_title;
        }
        virtual const TranslatedString& getTitle() const {…}
        virtual const TranslatedString& getCategory() const
        {
            return m_category;
        }
        virtual const TranslatedString& getCategory() const {…}
        virtual const String& stackTrace() const 
        { 
            return m_stack_trace;
        }
        virtual const String& stackTrace() const  {…}
        virtual uint04 getPriority() const
        {
            return m_priority;
        }
        virtual uint04 getPriority() const {…}
        
        const String& thread() const
        {
            return m_thread;
        }
        const String& thread() const {…}
        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;
    };
    class Exception {…};
 
};