NDEVR
API Documentation
LASPerformanceFactory.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: LASPerformanceFactory
29Included in API: True
30Author(s): Tyler Parke
31 *-----------------------------------------------------------------------------------------**/
32#pragma once
33#include "DLLInfo.h"
34#include <NDEVR/IOFactory.h>
35#include <NDEVR/FileFormat.h>
36namespace NDEVR
37{
38 class File;
39 class Model;
40 class FactoryFeatures;
41 class FactoryOptions;
48 class LAS_INTERFACE_API LASPerformanceFactory : public IOFactory
49 {
50 private:
52 LASPerformanceFactory();
53 public:
57 static LASPerformanceFactory* DefaultFactory();
70 void getSupportedFormats(Buffer<FileFormat>& formats, bool is_read) override;
75 bool canRead(const FactoryParameters& file) override;
80 bool readFile(FactoryParameters& file) override;
85 bool writeFile(FactoryParameters& file) override;
91 bool determineExtension(const File& file, String& extension) override;
98 Buffer<UUID> filterModelsToExport(Buffer<UUID> models_to_check, const DesignObjectLookup* lookup, const FileFormat& export_format) const override;
104 FactoryFeatures factoryFeatures(const FactoryParameters& file, bool is_import) const override;
128 static constexpr StringView const FactoryID() { return "LAS Factory"; }
129 protected:
131 };
132}
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
IOFactory(const StringView &factory_name)
Constructs an IOFactory with the given factory name.
static LASPerformanceFactory * DefaultFactory()
Gets the singleton LASPerformanceFactory instance.
static FileFormat LAZFormat()
Gets the FileFormat descriptor for LAZ (compressed LAS) files.
FactoryFeatures factoryFeatures(const FactoryParameters &file, bool is_import) const override
Gets the feature capabilities of this factory for a given file.
void setGeneratingSoftwareToTreatAsScan(const Buffer< String > &software)
Sets the list of generating software names that should treat data as scan data.
void getSupportedFormats(Buffer< FileFormat > &formats, bool is_read) override
Populates the buffer with supported file formats.
void clearGeneratingSoftwareToTreatAsScan()
Clears the list of generating software to treat as scan data.
bool writeFile(FactoryParameters &file) override
Writes design data to a LAS/LAZ file with optimized performance.
FactoryOptions defaultWriteOptions(const FactoryParameters &file) const override
Gets the default write options for a given file.
bool canRead(const FactoryParameters &file) override
Checks whether this factory can read the given file.
Buffer< UUID > filterModelsToExport(Buffer< UUID > models_to_check, const DesignObjectLookup *lookup, const FileFormat &export_format) const override
Filters models to only include those exportable in the given format.
static FileFormat LASFormat()
Gets the FileFormat descriptor for LAS files.
bool readFile(FactoryParameters &file) override
Reads a LAS/LAZ file with optimized performance.
void addGeneratingSoftwareToTreatAsScan(const StringView &software)
Adds a software name to the scan-treatment list.
bool determineExtension(const File &file, String &extension) override
Determines the file extension for the given file.
static constexpr StringView const FactoryID()
Gets the unique factory identifier string.
Buffer< String > m_generating_software_to_treat_as_scan
Software names whose output is treated as scan data.
FactoryOptions defaultReadOptions(const FactoryParameters &file) const override
Gets the default read options for a given file.
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