NDEVR
API Documentation
OMFFactory
Hardware and IO » IO Factories

Factory for reading and writing Open Mining Format (OMF) files. More...

Inheritance diagram for OMFFactory:
[legend]
Collaboration diagram for OMFFactory:
[legend]

Public Member Functions

 OMFFactory ()
 Constructs an OMFFactory with default settings.
Public Member Functions inherited from IOFactory
 IOFactory (const StringView &factory_name)
 Constructs an IOFactory with the given factory name.
virtual ~IOFactory ()
 Virtual destructor.
virtual bool canRead (const File &file)
 Checks whether this factory can read the given file.
virtual bool canRead (const FileFormat &file)
 Checks whether this factory can read the given file format.
virtual bool canWrite (const File &file)
 Checks whether this factory can write the given file.
virtual bool canWrite (const FileFormat &file)
 Checks whether this factory can write the given file format.
virtual FactoryOptions defaultReadOptions (const FactoryParameters &file) const
 Returns the default read options for the given factory parameters.
virtual FactoryOptions defaultWriteOptions (const FactoryParameters &file) const
 Returns the default write options for the given factory parameters.
virtual bool determineExtension (const File &file, String &extension)
 Attempts to determine the file extension for the given file.
virtual FactoryFeatures factoryFeatures (const FactoryParameters &file, bool is_import) const =0
 Returns the features and configurable options for this factory given the parameters.
String factoryReadAppFeature () const
 Returns the application feature string required for read operations.
String factoryWriteAppFeature () const
 Returns the application feature string required for write operations.
virtual Buffer< UUID > filterModelsToExport (Buffer< UUID > models_to_check, const DesignObjectLookup *lookup, const FileFormat &export_format) const
 Filters a list of model UUIDs to only those that can be exported in the given format.
virtual String getIcon (const File &file)
 Returns the icon name associated with the given file type.
void getSupportedFormats (Buffer< FileFormat > &formats)
 Populates the given buffer with all supported file formats (both read and write).
virtual void getSupportedFormats (Buffer< FileFormat > &formats, bool is_read)=0
 Populates the given buffer with supported file formats for reading or writing.
virtual void getSupportedFormats (Buffer< FileFormat > &formats, const File &file)
 Populates the given buffer with formats supported for the specified file.
virtual void getSupportedFormats (Buffer< FileFormat > &formats, DesignObjectLookup *lookup, const Buffer< UUID > &models)
 Populates the given buffer with formats supported for writing the specified models.
virtual void getSupportedFormatsByModelType (Buffer< FileFormat > &formats, bool is_read, const StringView &model_type)
 Populates the given buffer with formats matching a specific model type.
virtual void getSupportedFormatsForExtension (Buffer< FileFormat > &formats, bool is_read, const StringView &extension)
 Populates the given buffer with formats matching a specific file extension.
virtual bool isAutoEnabled () const
 Checks whether this factory is automatically enabled without requiring a password.
virtual bool isFactoryEnabled (bool is_read) const
 Checks whether this factory is enabled for reading or writing.
const String & name () const
 Returns the name of this factory.
Buffer< UUID > readFileWithDefaultSettings (const File &file, DesignObjectLookup *lookup)
 Reads a file using default settings and returns the UUIDs of the created models.
Buffer< Scene > readScenesFromFile (const File &file)
 Reads scenes from a file and returns them as a buffer of Scene objects.
void throwIfNotEnabled (bool is_read)
 Throws an exception if the factory is not enabled for the given operation direction.
virtual bool updateFromFile (const FactoryParameters &file, const FactoryOptions &old_options)
 Updates the factory parameters from a file, comparing against old options.
bool writeScenesToFile (const File &file, const Buffer< Scene > &scene)
 Writes a buffer of scenes to a file.

Protected Attributes

Buffer< uint01 > m_compression_data
 Temporary buffer used for decompressing OMF data blocks.

Private Member Functions

virtual bool canRead (const FactoryParameters &file) override
 Checks whether this factory can read the specified file.
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.
virtual bool writeFile (FactoryParameters &file) override
 Writes data to an OMF file using the given factory parameters.

Additional Inherited Members

Static Public Member Functions inherited from IOFactory
static void EnableExtension (const StringView &extension, const StringView &read_password, const StringView &write_password)
 Enables a specific file extension with the given read and write passwords.
static void EnableFactory (const StringView &factory, const StringView &read_password, const StringView &write_password)
 Enables a factory by name with the given read and write passwords.
static void EnableFactory (IOFactory *factory, const StringView &read_password, const StringView &write_password)
 Registers an IOFactory instance with the system, enabling it for read and/or write.

Detailed Description

Factory for reading and writing Open Mining Format (OMF) files.

Provides IOFactory support for the OMF file format, which is commonly used in mining and geological modeling to store 3D spatial data such as surfaces, volumes, and point sets.

Definition at line 49 of file OMFFactory.h.

Constructor & Destructor Documentation

◆ OMFFactory()

OMFFactory::OMFFactory ( )

Constructs an OMFFactory with default settings.

Member Function Documentation

◆ canRead()

virtual bool OMFFactory::canRead ( const FactoryParameters & file)
overrideprivatevirtual

Checks whether this factory can read the specified file.

Parameters
[in]fileThe factory parameters describing the file to check.

\returns True if the file can be read by this factory, false otherwise.

Reimplemented from IOFactory.

◆ canWrite()

virtual bool OMFFactory::canWrite ( const FactoryParameters & file)
overrideprivatevirtual

Checks whether this factory can write the specified file.

Parameters
[in]fileThe factory parameters describing the file to check.

\returns True if the file can be written by this factory, false otherwise.

Reimplemented from IOFactory.

◆ getSupportedFormats()

virtual Buffer< FileFormat > OMFFactory::getSupportedFormats ( )
overrideprivatevirtual

Returns the list of file formats supported by this factory.

\returns A Buffer of FileFormat entries describing OMF-compatible formats.

◆ readFile()

virtual bool OMFFactory::readFile ( FactoryParameters & file)
overrideprivatevirtual

Reads an OMF file and populates the given factory parameters with the resulting data.

Parameters
[in]fileThe factory parameters describing the file to read and where to store results.

\returns True if the file was read successfully, false otherwise.

Implements IOFactory.

◆ writeFile()

virtual bool OMFFactory::writeFile ( FactoryParameters & file)
overrideprivatevirtual

Writes data to an OMF file using the given factory parameters.

Parameters
[in]fileThe factory parameters describing the data to write and the target file.

\returns True if the file was written successfully, false otherwise.

Implements IOFactory.

The documentation for this class was generated from the following file: