AsciiFactory.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: IOFactory
File: AsciiFactory
Included in API: True
Author(s): Tyler Parke
 *-----------------------------------------------------------------------------------------**/
#pragma once
#include "DLLInfo.h"
#include <NDEVR/IOFactory.h>
#include <NDEVR/FactoryFeatures.h>
#include <NDEVR/FactoryOptions.h>
namespace NDEVR
{
    struct ASCIIPointOptions;
    /**--------------------------------------------------------------------------------------------------
    \brief writes points of data to a plain-text file based on FactoryOptions.
    AsciiFactories allow for defining multiple columns of data to be streamed out to the text file.
    **/
    class NDEVR_FACTORY_API AsciiFactory : public IOFactory
    {
    public:
        AsciiFactory();
        AsciiFactory(const String& name);
        static FileFormat PointFormat();
#if NDEVR_STATION_MODEL
        static FileFormat StationFormat(bool is_read);
#endif
        static DesignParameter NoneParameter();
        virtual void getSupportedFormats(Buffer<FileFormat>& formats, bool is_read) override;
        virtual void getSupportedFormats(Buffer<FileFormat>& formats, DesignObjectLookup* lookup, const Buffer<UUID>& models) override;
        virtual void getSupportedFormatsByModelType(Buffer<FileFormat>& formats, bool is_read, const String& model_type) override;
        virtual String getIcon(const File& file) override;
        virtual bool isRecursiveWrite(const FactoryParameters& params) const;
        virtual bool readFile(FactoryParameters& parameters) override;
        virtual bool writeFile(FactoryParameters& parameters) override;
        virtual bool writeToString(String& output, const FactoryParameters& parameters, uint04 max_line_count);
        static void WriteHeaders(const AsciiOptions& options, String& string, bool add_new_line = true);
        bool canRead(const FactoryParameters& file) override;
        Buffer<UUID> filterModelsToExport(Buffer<UUID> models_to_check, const DesignObjectLookup* lookup, const FileFormat& export_format) const override;
        static ASCIIPointOptions ReadPoints(FactoryParameters& parameters, Model& root, Buffer<DesignParameter>& params);
#if NDEVR_STATION_MODEL
        static void ReadStations(FactoryParameters& parameters, const Buffer<DesignParameter>& params);
#endif
        FactoryFeatures factoryFeatures(const FactoryParameters& file, bool is_import) const override;
        FactoryOptions defaultReadOptions(const FactoryParameters& file) const override;
        FactoryOptions defaultWriteOptions(const FactoryParameters& file) const override;
    };
}