AsciiFileOutputStream.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: AsciiFileOutputStream
Included in API: True
Author(s): Tyler Parke
 *-----------------------------------------------------------------------------------------**/
#pragma once
#include <NDEVR/LogStream.h>
#include <NDEVR/File.h>
namespace NDEVR
{
    class File;
    class AsciiWriteThread;
    /**--------------------------------------------------------------------------------------------------
    Class: AsciiFileOutputStream
 
    \brief When attached to a log, writes messages directly to a specified ascii file
    *-----------------------------------------------------------------------------------------------**/
    class NDEVR_BASE_API AsciiFileOutputStream final : public LogStream
    {
    public:
        explicit AsciiFileOutputStream(const File& file, bool append);
        virtual ~AsciiFileOutputStream();
        void setProgress(fltp04) final override { };
        void addMessage(const LogMessage& message) final override;
        void setFile(const File& file, bool append);
        void moveFile(File new_location);
        void copyFile(File new_location);
        const File& file() const;
#if NDEVR_SUPPORTS_THREADING
        void addMessages(const Buffer<LogMessage>& messages) final override;
#endif
        static void ReadLogFile(ProgressInfo* stream, const File& file);
    private:
#if NDEVR_SUPPORTS_THREADING
        AsciiWriteThread* m_write_thread;
#else
        File m_file;
        String m_separator;
        String m_new_line;
#endif
    };
}