NDEVR
API Documentation
GeoSlamFactory.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: GeoSlamFactory
29Included in API: True
30Author(s): Tyler Parke
31 *-----------------------------------------------------------------------------------------**/
32#pragma once
33#include "DLLInfo.h"
34#include "IOFactory/Headers/IOFactory.h"
35#include "Base/Headers/FileFormat.h"
36#include "Base/Headers/Buffer.hpp"
37class LASreader;
38namespace NDEVR
39{
40 class File;
41 class Model;
42 class FactoryFeatures;
43 class FactoryOptions;
50 {
51 public:
57 void getSupportedFormats(Buffer<FileFormat>& formats, bool is_read) override;
61 bool canRead(const FactoryParameters& file) override;
75 Buffer<UUID> filterModelsToExport(Buffer<UUID> models_to_check, const DesignObjectLookup* lookup, const FileFormat& export_format) const override;
80 FactoryFeatures factoryFeatures(const FactoryParameters& file, bool is_import) const override;
89 };
90}
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.
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
bool readFile(FactoryParameters &file) override
Reads a GeoSLAM file into the design model.
Buffer< UUID > filterModelsToExport(Buffer< UUID > models_to_check, const DesignObjectLookup *lookup, const FileFormat &export_format) const override
Filters the given models to only those exportable in the specified format.
GeoSlamFactory()
Constructs a GeoSlamFactory.
FactoryFeatures factoryFeatures(const FactoryParameters &file, bool is_import) const override
Returns the factory feature set for the given parameters.
bool canRead(const FactoryParameters &file) override
Checks whether the given file can be read by this factory.
bool writeFile(FactoryParameters &file) override
Writes the design model to a GeoSLAM file.
FactoryOptions defaultReadOptions(const FactoryParameters &file) const override
Returns the default read options for the given file.
void getSupportedFormats(Buffer< FileFormat > &formats, bool is_read) override
Populates the buffer with supported file formats.
FactoryOptions defaultWriteOptions(const FactoryParameters &file) const override
Returns the default write options for the given file.
IOFactory(const StringView &factory_name)
Constructs an IOFactory with the given factory name.
A core class that represents a node on model hierarchy.
Definition Model.h:292
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