IredesPatternFactory

An IOFactory implementation for reading and writing IREDES (International Rock Excavation Data Exchange Standard) drill pattern files. More...

Inheritance diagram for IredesPatternFactory:

Collaboration diagram for IredesPatternFactory:

Public Member Functions
	IredesPatternFactory ()
	Constructs an IredesPatternFactory.
bool	canRead (const File &file) override
	Checks whether the given file can be read by this factory.
virtual void	getSupportedFormats (Buffer< FileFormat > &formats, bool is_read) override
	Populates the buffer with supported file formats.
virtual void	getSupportedFormatsByModelType (Buffer< FileFormat > &formats, bool is_read, const StringView &model_type) override
	Populates the buffer with supported formats filtered by model type.
virtual bool	readFile (FactoryParameters &file) override
	Reads an IREDES file into the design model.
virtual bool	writeFile (FactoryParameters &file) override
	Writes the design model to an IREDES file.
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 FactoryParameters &file)
	Checks whether this factory can read using the given FactoryParameters.
virtual bool	canRead (const FileFormat &file)
	Checks whether this factory can read the given file format.
virtual bool	canWrite (const FactoryParameters &file)
	Checks whether this factory can write using the given FactoryParameters.
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, 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	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.

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

An IOFactory implementation for reading and writing IREDES (International Rock Excavation Data Exchange Standard) drill pattern files.

---

Definition at line 54 of file IredesPatternFactory.h.

Member Function Documentation

canRead()

bool IredesPatternFactory::canRead ( const File & file )

overridevirtual

Checks whether the given file can be read by this factory.

Parameters

[in]

file

The file to check.

Returns

True if the file can be read.

Reimplemented from IOFactory.

getSupportedFormats()

virtual void IredesPatternFactory::getSupportedFormats ( Buffer< FileFormat > & formats, bool is_read )

overridevirtual

Populates the buffer with supported file formats.

Parameters

[in]	formats	The buffer to populate.
[in]	is_read	Whether to list read formats (true) or write formats (false).

Implements IOFactory.

getSupportedFormatsByModelType()

virtual void IredesPatternFactory::getSupportedFormatsByModelType ( Buffer< FileFormat > & formats, bool is_read, const StringView & model_type )

overridevirtual

Populates the buffer with supported formats filtered by model type.

Parameters

[in]	formats	The buffer to populate.
[in]	is_read	Whether to list read formats (true) or write formats (false).
[in]	model_type	The model type to filter by.

Reimplemented from IOFactory.

readFile()

virtual bool IredesPatternFactory::readFile ( FactoryParameters & file )

overridevirtual

Reads an IREDES file into the design model.

Parameters

[in]

file

The factory parameters for the read operation.

Returns

True if the file was read successfully.

Implements IOFactory.

writeFile()

virtual bool IredesPatternFactory::writeFile ( FactoryParameters & file )

overridevirtual

Writes the design model to an IREDES file.

Parameters

[in]

file

The factory parameters for the write operation.

Returns

True if the file was written successfully.

Implements IOFactory.

---

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

• Iredes/Headers/IredesPatternFactory.h