NDEVR
API Documentation
OMFFactory.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: OMFFactory
29Included in API: True
30Author(s): Tyler Parke
31 *-----------------------------------------------------------------------------------------**/
32#pragma once
33#if NDEVR_SUPPORTS_OMF
34#include <NDEVR/IOFactory.h>
35#include <NDEVR/File.h>
36namespace NDEVR
37{
38 class FactoryOptions;
39 class Model;
40 class Log;
41 class FactoryFeatures;
49 class OMFFactory : public IOFactory
50 {
51 public:
56 private:
67 virtual bool canRead(const FactoryParameters& file) override;
73 virtual bool canWrite(const FactoryParameters& file) override;
79 virtual bool readFile(FactoryParameters& file) override;
85 virtual bool writeFile(FactoryParameters& file) override;
92 FactoryFeatures getFactoryFeatures(const FactoryParameters& file, bool is_read);
93 protected:
95 };
96};
97#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.
IOFactory(const StringView &factory_name)
Constructs an IOFactory with the given factory name.
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
Buffer< uint01 > m_compression_data
Temporary buffer used for decompressing OMF data blocks.
Definition OMFFactory.h:94
virtual bool writeFile(FactoryParameters &file) override
Writes data to an OMF file using the given factory parameters.
virtual bool canRead(const FactoryParameters &file) override
Checks whether this factory can read the specified file.
OMFFactory()
Constructs an OMFFactory with default settings.
virtual bool canWrite(const FactoryParameters &file) override
Checks whether this factory can write the specified file.
virtual Buffer< FileFormat > getSupportedFormats() override
Returns the list of file formats supported by this factory.
virtual bool readFile(FactoryParameters &file) override
Reads an OMF file and populates the given factory parameters with the resulting data.
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