ModelFactory.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: ModelFactory
Included in API: True
Author(s): Tyler Parke
 *-----------------------------------------------------------------------------------------**/
#pragma once
#include <NDEVR/IOFactory.h>
#include <NDEVR/File.h>
#include <NDEVR/FactoryOptions.h>
namespace NDEVR
{
    /**--------------------------------------------------------------------------------------------------
    \brief The core logic for importing and exporting files from the model heirarchy. Stores a series
        of IOFactory children that can define when and how they are able to export or import data.
 
    Based on options will select the proper IOFactory to perform the import or export task.
    **/
    class NDEVR_FACTORY_API ModelFactory : public IOFactory, public SoftwareServiceManager
    {
    protected:
        ModelFactory();
        ~ModelFactory();
    public:
        static ModelFactory& DefaultFactory();
        virtual void getSupportedFormats(Buffer<FileFormat>& formats, bool is_read) override;
        virtual void getSupportedFormats(Buffer<FileFormat>& formats, const File& file) override { IOFactory::getSupportedFormats(formats, file); };
        virtual void getSupportedFormatsByModelType(Buffer<FileFormat>& formats, bool is_read, const String& model_type) override;
        virtual void getSupportedFormats(Buffer<FileFormat>& formats, DesignObjectLookup* lookup, const Buffer<UUID>& models) override;
        virtual String getIcon(const File& file) override;
        virtual bool canRead(const FactoryParameters& file) override;
        virtual bool canWrite(const FactoryParameters& file) override;
        virtual bool determineExtension(const File& file, String& extension) override;
        virtual FactoryOptions defaultReadOptions(const FactoryParameters& file) const override;
        virtual FactoryOptions defaultWriteOptions(const FactoryParameters& file) const override;
        virtual Buffer<UUID> filterModelsToExport(Buffer<UUID> models_to_check, const DesignObjectLookup* lookup, const FileFormat& export_format) const override;
        FactoryFeatures factoryFeatures(const FactoryParameters& file, bool is_import) const override;
        virtual bool canRead(const File& file) override;
        virtual bool canWrite(const File& file) override;
        virtual bool readFile(FactoryParameters& file) override;
        virtual bool updateFromFile(const FactoryParameters& file, const FactoryOptions& old_options) override;
        virtual bool writeFile(FactoryParameters& file) override;
        void addFactory(IOFactory* factory);
        void addFactory(String extension, IOFactory* factory);
        void enableExtension(String extension, const String& read_password, const String& write_password);
        void enableFactory(IOFactory* factory, const String& read_password, const String& write_password);
        void enableFactory(const String& factory, const String& read_password, const String& write_password);
        void clearFactories();
    protected:
        Buffer<IOFactory*>* m_factory_objects;
        Dictionary<String, IOFactory*> m_extension_factories;
        Dictionary<String, IOFactory*> m_named_factories;
        Dictionary<String, String> m_extension_read_passwords;
        Dictionary<String, String> m_extension_write_passwords;
    };
}