NDEVR
API Documentation
XLXSFactory.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#include <NDEVR/IOFactory.h>
35#include <NDEVR/AsciiIODataBlock.h>
36namespace NDEVR
37{
38 class Table;
39 class InfoPipe;
40 class File;
41 class Model;
42 class FactoryFeatures;
43 class FactoryOptions;
44 class String;
49 class XLXSFactory : public IOFactory
50 {
51 public:
52 OPENXLSX_INTERFACE_API XLXSFactory();
53 OPENXLSX_INTERFACE_API virtual void getSupportedFormats(Buffer<FileFormat>& formats, bool is_read) override;
54 OPENXLSX_INTERFACE_API virtual bool readFile(FactoryParameters& params) override;
55 OPENXLSX_INTERFACE_API virtual bool writeFile(FactoryParameters& file) override;
56 OPENXLSX_INTERFACE_API virtual FactoryFeatures factoryFeatures(const FactoryParameters& file, bool is_import) const override;
57 OPENXLSX_INTERFACE_API FactoryOptions defaultReadOptions(const FactoryParameters& file) const override;
58 OPENXLSX_INTERFACE_API void writeData(const AsciiTableIOData& data) const;
59 OPENXLSX_INTERFACE_API static XLXSFactory& DefaultFactory();
60
61 };
62}
Holds the data and file paths needed for ASCII table-based import/export operations,...
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...
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
FactoryOptions defaultReadOptions(const FactoryParameters &file) const override
Returns the default read options for the given factory parameters.
virtual bool writeFile(FactoryParameters &file) override
Writes data from the design object hierarchy to a file.
virtual void getSupportedFormats(Buffer< FileFormat > &formats, bool is_read) override
Populates the given buffer with supported file formats for reading or writing.
virtual FactoryFeatures factoryFeatures(const FactoryParameters &file, bool is_import) const override
Returns the features and configurable options for this factory given the parameters.
virtual bool readFile(FactoryParameters &params) override
Reads data from a file into the design object hierarchy.
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