LogMessage.h

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: LogMessage
Included in API: True
Author(s): Tyler Parke
 *-----------------------------------------------------------------------------------------**/
#pragma once
#include <NDEVR/Time.h>
#include <NDEVR/String.h>
#include <NDEVR/TranslatedString.h>
 
namespace NDEVR
{
    /**--------------------------------------------------------------------------------------------------
    \brief A class that allows for specific log information to be conveyed to a ProgressInfo object
        including information about severity and timestamp information
    **/
    class LogMessage : public String
    {
    public:
        enum ApplicationMessagePriority : uint01
        {
              e_success = 0
            , e_debug = 1
            , e_logged_debug = 2
            , e_notification = 5
            , e_warning = 50
            , e_error = 150
            , e_critical_error = 250
        };
 
    public:
        LogMessage()
            : String()
            , m_time(Constant<Time>::Invalid)
            , m_error_level(0)
        {}
        LogMessage(const Time& time, const char* message, const uint01 error_level = e_notification)
            : String(message)
            , m_time(time)
            , m_error_level(error_level)
        {
            formatMessage();
        }
        explicit LogMessage(const char* message, const uint01 error_level = e_notification)
            : String(message)
            , m_time(Time::SystemTime())
            , m_error_level(error_level)
        {
            formatMessage();
        }
        explicit LogMessage(const String& message, const uint01 error_level = e_notification)
            : String(message)
            , m_time(Time::SystemTime())
            , m_error_level(error_level)
        {
            formatMessage();
        }
        explicit LogMessage(const TranslatedString& message, const uint01 error_level = e_notification)
            : String(message.translation())
            , m_time(Time::SystemTime())
            , m_error_level(error_level)
        {
            formatMessage();
        }
        void formatMessage()
        {
            replace("\n", "\\n");
            replace("\r", "\\r");
            replace("\t", "\\t");
        }
        inline Time recordTime() const {
            return m_time;
        }
        inline uint01 logRecordLevel() const {
            return m_error_level;
        }
    protected:
        Time m_time;
        uint01 m_error_level;
    };
}