ProgressInfo.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: ProgressInfo
Included in API: True
Author(s): Tyler Parke
 *-----------------------------------------------------------------------------------------**/
#pragma once
#include "DLLInfo.h"
#include <NDEVR/BaseValues.h>
 
namespace NDEVR
{
    class String;
    class LogStream;
    class LogMessage;
    class TranslatedString;
 
    /**--------------------------------------------------------------------------------------------------
    \brief A light-weight base class for Log that allows processes to update, without the need for 
        additional include overheads.
    **/
    class NDEVR_BASE_API ProgressInfo
    {
    public: 
        ProgressInfo() noexcept {};
        virtual ~ProgressInfo(){};
        virtual bool setProgress(fltp04 percent) = 0;
        virtual void allowCancel(bool cancel) = 0;
        virtual bool addMessage(const LogMessage& message) = 0;
        virtual bool addMessage(const String& message, uint01 log_level = 10) = 0;
        virtual bool addMessage(const char* const message, uint01 log_level = 10) = 0;
        virtual bool addMessage(const TranslatedString& message, uint01 log_level = 10) = 0;
        virtual void addStream(LogStream*, bool) {}
        virtual void removeStream(LogStream*) {}
        virtual void setCancelRequest(bool) {}
        virtual bool cancelRequested() const { return false; }
    };
};