NDEVR
API Documentation
DNBJSONFactory.h
1/*--------------------------------------------------------------------------------------------
2Copyright (c) 2020, NDEVR LLC
3tyler.parke@ndevr.org
4 __ __ ____ _____ __ __ _______
5 | \ | | | __ \ | ___|\ \ / / | __ \
6 | \ | | | | \ \ | |___ \ \ / / | |__) |
7 | . \| | | |__/ / | |___ \ V / | _ /
8 | |\ |_|_____/__|_____|___\_/____| | \ \
9 |__| \__________________________________| \__\
10
11Subject to the terms of the Enterprise+ Agreement, NDEVR hereby grants
12Licensee a limited, non-exclusive, non-transferable, royalty-free license
13(without the right to sublicense) to use the API solely for the purpose of
14Licensee's internal development efforts to develop applications for which
15the API was provided.
16
17The above copyright notice and this permission notice shall be included in all
18copies or substantial portions of the Software.
19
20THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
21INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
22PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
23FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
24OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
25DEALINGS IN THE SOFTWARE.
26
27Library: IOFactory
28File: DNBJSONFactory
29Included in API: True
30Author(s): tyler.parke
31 *-----------------------------------------------------------------------------------------**/
32
33#pragma once
34#include "DLLInfo.h"
35#include <NDEVR/IOFactory.h>
36#include <NDEVR/File.h>
37namespace NDEVR
38{
39 class Model;
40 class Log;
41 class FactoryFeatures;
50 {
51 public:
55 protected:
63 void getSupportedFormats(Buffer<FileFormat>& formats, bool is_read) final override;
68 virtual void getSupportedFormatsByModelType(Buffer<FileFormat>& formats, bool is_read, const StringView& model_type) override;
72 String getIcon(const File & file) final override;
76 bool readFile(FactoryParameters & file) final override;
80 bool canRead(const File& file) final override;
84 bool canWrite(const File& file) final override;
88 bool writeFile(FactoryParameters&) final override;
91 bool isAutoEnabled() const final override;
95 FactoryOptions defaultReadOptions(const FactoryParameters & file) const final override;
99 FactoryOptions defaultWriteOptions(const FactoryParameters & file) const final override;
105 Buffer<UUID> filterModelsToExport(Buffer<UUID> models_to_check, const DesignObjectLookup* lookup, const FileFormat& export_format) const final override;
110 FactoryFeatures factoryFeatures(const FactoryParameters& file, bool is_import) const override;
115 bool determineExtension(const File& file, String & extension) final override;
116 };
117}
Provides cross-platform DLL export/import macros for the IOFactory module.
#define NDEVR_FACTORY_API
GCC/Clang symbol visibility — marks symbols as visible in the shared library.
Definition DLLInfo.h:92
The equivelent of std::vector but with a bit more control.
Definition Buffer.hpp:58
void getSupportedFormats(Buffer< FileFormat > &formats, bool is_read) final override
Populates the given buffer with file formats supported by this factory.
static DNBJSONFactory * DefaultFactory()
Retrieves the singleton default instance of DNBJSONFactory.
String getIcon(const File &file) final override
Retrieves the icon resource name associated with the given file.
bool determineExtension(const File &file, String &extension) final override
Determines the appropriate file extension for the given file.
bool readFile(FactoryParameters &file) final override
Reads a DNB JSON file and populates the design model from its contents.
bool canRead(const File &file) final override
Checks whether this factory can read the given file.
FactoryOptions defaultWriteOptions(const FactoryParameters &file) const final override
Retrieves the default write options for the given file.
virtual void getSupportedFormatsByModelType(Buffer< FileFormat > &formats, bool is_read, const StringView &model_type) override
Populates the given buffer with file formats supported for a specific model type.
FactoryOptions defaultReadOptions(const FactoryParameters &file) const final override
Retrieves the default read options for the given file.
DNBJSONFactory()
Constructs a DNBJSONFactory instance.
Buffer< UUID > filterModelsToExport(Buffer< UUID > models_to_check, const DesignObjectLookup *lookup, const FileFormat &export_format) const final override
Filters a set of model UUIDs to determine which should be included in an export.
bool isAutoEnabled() const final override
Indicates whether this factory is automatically enabled for file operations.
bool writeFile(FactoryParameters &) final override
Writes design data to a DNB JSON file.
bool canWrite(const File &file) final override
Checks whether this factory can write to the given file.
FactoryFeatures factoryFeatures(const FactoryParameters &file, bool is_import) const override
Retrieves the feature set supported by this factory for the given file context.
A core class where all Design Objects including models, materials, and geometries are stored.
Allows IOFactories to report what features they support to make the import/export dialogs easier to s...
User-defined options that define preferences for importing and exporting using IOFactory objects.
Data that describes a particular file format and how to use the format with the program.
Definition FileFormat.h:45
Logic for reading or writing to a file as well as navigating filesystems or other common file operati...
Definition File.h:53
IOFactory(const StringView &factory_name)
Constructs an IOFactory with the given factory name.
Serves as the primary program interface for processes to report issues and allows any number of LogSt...
Definition Log.h:50
A core class that represents a node on model hierarchy.
Definition Model.h:292
The core String View class for the NDEVR API.
Definition StringView.h:58
The core String class for the NDEVR API.
Definition String.h:95
A universally unique identifier (UUID) is a 128-bit number used to identify information in computer s...
Definition UUID.h:61
The primary namespace for the NDEVR SDK.
A container of input information that is to be filled with output information by an IOFactory.
Definition IOFactory.h:105