NDEVR
API Documentation
LandXMLFactory.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: LandXMLFactory
29Included in API: True
30Author(s): Tyler Parke
31 *-----------------------------------------------------------------------------------------**/
32#pragma once
33#include <NDEVR/IOFactory.h>
34#include <NDEVR/File.h>
35namespace NDEVR
36{
37 class Model;
38 class Log;
39 class FactoryFeatures;
53 {
54 public:
57 private:
61 virtual void getSupportedFormats(Buffer<FileFormat>& formats, bool is_read) override;
65 virtual String getIcon(const File& file) override;
69 virtual bool readFile(FactoryParameters& file) override;
73 virtual bool canRead(const File& file) override;
76 virtual bool writeFile(FactoryParameters&) override { return false; };
85 FactoryFeatures factoryFeatures(const FactoryParameters& file, bool is_import) const override;
86 };
87};
#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
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.
virtual String getIcon(const File &file) override
Returns the icon resource name associated with LandXML files.
FactoryOptions defaultReadOptions(const FactoryParameters &file) const override
Provides the default read options for a LandXML file.
virtual bool canRead(const File &file) override
Checks whether the given file can be read by this factory.
FactoryFeatures factoryFeatures(const FactoryParameters &file, bool is_import) const override
Reports the capabilities of this factory for the given file.
LandXMLFactory()
Constructs the LandXMLFactory and registers supported LandXML file extensions.
virtual bool writeFile(FactoryParameters &) override
Write support is not implemented for LandXML.
virtual bool readFile(FactoryParameters &file) override
Reads and imports data from a LandXML file into the design model.
virtual void getSupportedFormats(Buffer< FileFormat > &formats, bool is_read) override
Populates the list of file formats this factory can handle.
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 class for the NDEVR API.
Definition String.h:95
The primary namespace for the NDEVR SDK.
@ file
The source file path associated with this object.
A container of input information that is to be filled with output information by an IOFactory.
Definition IOFactory.h:105