NDEVR
API Documentation
IredesPatternFactory.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: E57Factory
29Included in API: True
30Author(s): Tyler Parke
31 *-----------------------------------------------------------------------------------------**/
32#pragma once
33#include "DLLInfo.h"
34#if NDEVR_SUPPORTS_IREDES
35#include <NDEVR/IOFactory.h>
36#include <NDEVR/FileFormat.h>
37#include <NDEVR/BaseValues.h>
38#include <NDEVR/Buffer.h>
39namespace NDEVR
40{
41 class Table;
42 class InfoPipe;
43 class File;
44 class Model;
45 class FactoryFeatures;
46 class FactoryOptions;
47 class String;
48
54 class IREDES_INTERFACE_API IredesPatternFactory : public IOFactory
55 {
56 public:
62 virtual void getSupportedFormats(Buffer<FileFormat>& formats, bool is_read) override;
67 virtual void getSupportedFormatsByModelType(Buffer<FileFormat>& formats, bool is_read, const StringView& model_type) override;
71 virtual bool readFile(FactoryParameters& file) override;
75 bool canRead(const File& file) override;
79 virtual bool writeFile(FactoryParameters& file) override;
80
81 };
82};
83#endif
The equivelent of std::vector but with a bit more control.
Definition Buffer.hpp:58
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.
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.
A light-weight base class for Log that allows processes to update, without the need for additional in...
virtual void getSupportedFormatsByModelType(Buffer< FileFormat > &formats, bool is_read, const StringView &model_type) override
Populates the buffer with supported formats filtered by model type.
bool canRead(const File &file) override
Checks whether the given file can be read by this factory.
IredesPatternFactory()
Constructs an IredesPatternFactory.
virtual bool writeFile(FactoryParameters &file) override
Writes the design model to an IREDES file.
virtual bool readFile(FactoryParameters &file) override
Reads an IREDES file into the design model.
virtual void getSupportedFormats(Buffer< FileFormat > &formats, bool is_read) override
Populates the buffer with supported file formats.
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.
A container of input information that is to be filled with output information by an IOFactory.
Definition IOFactory.h:105