LogStream.h

/*--------------------------------------------------------------------------------------------
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/InfoPipe.h>
#include <NDEVR/Buffer.h>
#include <NDEVR/LogMessage.h>
#include <NDEVR/Dictionary.h>
#include "ProgressSource.h"
namespace NDEVR
{
    class LogMessage;
    class LogStream
    {
    public:
        inline virtual ~LogStream()
        {
            clearLinks();
        }

        inline virtual void attach(InfoPipe* stream)
        {
            m_linked_logs.add(stream);
        }

        inline virtual void detach(InfoPipe* stream)
        {
            m_linked_logs.removeElement(stream);
        }

        inline virtual void allowCancel(bool) {}
        inline virtual void allowInput(bool) {}
        virtual void setProgress(uint04 id, fltp04 progress) = 0;
        virtual void addMessage(uint04 id, const LogMessage& message) = 0;
        virtual void addProgressSource(const TranslatedString& name, uint04 idx, fltp04 progress)
        {
            m_progress_sources.insert({idx, {name, idx, progress}});
        };

        virtual void removeProgressSource(uint04 idx)
        {
            m_progress_sources.erase(idx);
        };

        inline virtual void addMessages(uint04 id, const Buffer<LogMessage>& messages)
        {
            for (uint04 i = 0; i < messages.size(); i++)
                addMessage(id, messages[i]);
        }

        inline void clearLinks()
        {
            for (uint04 i = 0; i < m_linked_logs.size(); i++)
            {
                m_linked_logs[i]->removeStream(this);
            }
            m_linked_logs.clear();
        }

        inline void setIgnoreMessages(bool ignore)
        {
            m_ignore_message = ignore;
        }

        inline bool ignoringMessages() const
        {
            return m_ignore_message;
        }
    protected:
        Dictionary<uint04, ProgressSource> m_progress_sources; 
        Buffer<InfoPipe*> m_linked_logs; 
        bool m_ignore_message = false; 
    };
}