LogStream.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: LogStream
Included in API: True
Author(s): Tyler Parke
 *-----------------------------------------------------------------------------------------**/
#pragma once
#include "DLLInfo.h"
#include <NDEVR/BaseValues.h>
#include <NDEVR/ProgressInfo.h>
#include <NDEVR/Buffer.h>
#include <NDEVR/LogMessage.h>
namespace NDEVR
{
    class LogMessage;
    /**--------------------------------------------------------------------------------------------------
    \brief A class that listens to a log object and processes the updates in a specified way. Any number
        of LogStreams can be attached to a ProgressInfo object and will be updated in real time.
    **/
    class NDEVR_BASE_API LogStream
    {
    public:
        virtual ~LogStream()
        {
            clearLinks();
        }
        virtual void attach(ProgressInfo* stream)
        {
            m_linked_logs.add(stream);
        }
        virtual void detach(ProgressInfo* stream)
        {
            m_linked_logs.removeElement(stream);
        }
        virtual void allowCancel(bool) {}
        virtual void setProgress(fltp04 progress) = 0;
        virtual void addMessage(const LogMessage& message) = 0;
        virtual void addMessages(const Buffer<LogMessage>& messages)
        {
            for (uint04 i = 0; i < messages.size(); i++)
            {
                addMessage(messages[i]);
            }
        }
        void clearLinks()
        {
            for (uint04 i = 0; i < m_linked_logs.size(); i++)
            {
                m_linked_logs[i]->removeStream(this);
            }
            m_linked_logs.clear();
        }
        void setIgnoreMessages(bool ignore)
        {
            m_ignore_message = ignore;
        }
        bool ignoringMessages() const
        {
            return m_ignore_message;
        }
    protected:
        Buffer<ProgressInfo*> m_linked_logs;
        bool m_ignore_message = false;
    };
}