NDEVR
API Documentation
AsciiFactory.h
1/*--------------------------------------------------------------------------------------------
2Copyright (c) 2019, 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: AsciiFactory
29Included in API: True
30Author(s): Tyler Parke
31 *-----------------------------------------------------------------------------------------**/
32#pragma once
33#include "DLLInfo.h"
34#include <NDEVR/IOFactory.h>
35#include <NDEVR/FactoryFeatures.h>
36#include <NDEVR/FactoryOptions.h>
37namespace NDEVR
38{
39
43 struct ASCIIPointOptions;
44
55 {
56 public:
61
67
73
74#if NDEVR_STATION_MODEL
80 static FileFormat StationFormat(bool is_read);
81#endif
82
88
94 virtual void getSupportedFormats(Buffer<FileFormat>& formats, bool is_read) override;
95
102 virtual void getSupportedFormats(Buffer<FileFormat>& formats, DesignObjectLookup* lookup, const Buffer<UUID>& models) override;
103
110 virtual void getSupportedFormatsByModelType(Buffer<FileFormat>& formats, bool is_read, const StringView& model_type) override;
111
117 virtual String getIcon(const File& file) override;
118
124 virtual bool isRecursiveWrite(const FactoryParameters& params) const;
125
131 virtual bool readFile(FactoryParameters& parameters) override;
132
138 virtual bool writeFile(FactoryParameters& parameters) override;
139
147 virtual bool writeToString(String& output, const FactoryParameters& parameters, uint04 max_line_count);
148
155 static void WriteHeaders(const AsciiOptions& options, String& string, bool add_new_line = true);
156
162 bool canRead(const FactoryParameters& file) override;
163
171 Buffer<UUID> filterModelsToExport(Buffer<UUID> models_to_check, const DesignObjectLookup* lookup, const FileFormat& export_format) const override;
172
180 static ASCIIPointOptions ReadPoints(FactoryParameters& parameters, Model& root, Buffer<DesignParameter>& params);
181
182#if NDEVR_STATION_MODEL
188 static void ReadStations(FactoryParameters& parameters, const Buffer<DesignParameter>& params);
189#endif
190
197 FactoryFeatures factoryFeatures(const FactoryParameters& file, bool is_import) const override;
198
205
212 };
213}
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
Buffer< UUID > filterModelsToExport(Buffer< UUID > models_to_check, const DesignObjectLookup *lookup, const FileFormat &export_format) const override
Filters a set of model UUIDs to only those that can be exported in the given format.
virtual bool isRecursiveWrite(const FactoryParameters &params) const
Checks whether writing should recurse into child models.
static void WriteHeaders(const AsciiOptions &options, String &string, bool add_new_line=true)
Writes column header names to a string based on the given ASCII options.
FactoryOptions defaultWriteOptions(const FactoryParameters &file) const override
Returns the default write options for the given file.
FactoryFeatures factoryFeatures(const FactoryParameters &file, bool is_import) const override
Returns the feature set supported by this factory for the given file and direction.
virtual bool writeFile(FactoryParameters &parameters) override
Writes design objects to an ASCII file.
virtual void getSupportedFormats(Buffer< FileFormat > &formats, bool is_read) override
Populates the given buffer with file formats supported by this factory.
static DesignParameter NoneParameter()
Returns a DesignParameter representing a "none" or empty column mapping.
bool canRead(const FactoryParameters &file) override
Checks whether this factory can read the specified file.
virtual bool writeToString(String &output, const FactoryParameters &parameters, uint04 max_line_count)
Writes design data to a string instead of a file, up to a maximum number of lines.
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 override
Returns the default read options for the given file.
virtual bool readFile(FactoryParameters &parameters) override
Reads an ASCII file and populates design objects from the parsed data.
static ASCIIPointOptions ReadPoints(FactoryParameters &parameters, Model &root, Buffer< DesignParameter > &params)
Reads point data from an ASCII file into a model and populates parameter mappings.
virtual String getIcon(const File &file) override
Returns the icon name associated with a given file.
static FileFormat PointFormat()
Returns the FileFormat descriptor for ASCII point files.
virtual void getSupportedFormats(Buffer< FileFormat > &formats, DesignObjectLookup *lookup, const Buffer< UUID > &models) override
Populates the given buffer with file formats supported for specific models.
AsciiFactory()
Constructs a default AsciiFactory with standard settings.
AsciiFactory(const StringView &name)
Constructs an AsciiFactory with a specific name identifier.
Storage class for all IO options related to an Ascii file output used by an IOFactory services that w...
The equivelent of std::vector but with a bit more control.
Definition Buffer.hpp:58
A core class where all Design Objects including models, materials, and geometries are stored.
A definition of data that is logically stored in the Model hierarchy.
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.
const String & name() const
Returns the name of this factory.
Definition IOFactory.h:262
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
The primary namespace for the NDEVR SDK.
uint32_t uint04
-Defines an alias representing a 4 byte, unsigned integer -Can represent exact integer values 0 throu...
A container of input information that is to be filled with output information by an IOFactory.
Definition IOFactory.h:105