IOFactory interface for reading and writing MagneticCalibrationData to files. More...

Inheritance diagram for MagneticCalibrationFactory:

Collaboration diagram for MagneticCalibrationFactory:

Private Member Functions
virtual FactoryFeatures	factoryFeatures (const FactoryParameters &file, bool is_import) const override
	Returns the feature flags for this factory.
Buffer< UUID >	filterModelsToExport (Buffer< UUID > models_to_check, const DesignObjectLookup *lookup, const FileFormat &export_format) const override
	Filters a list of models to only those exportable by this factory.
void	getSupportedFormats (Buffer< FileFormat > &formats, bool is_read) override
	Populates the list of supported file formats for reading and writing.
bool	readFile (FactoryParameters &file) override
	Reads magnetic calibration data from a file.
bool	writeFile (FactoryParameters &file) override
	Writes magnetic calibration data to a file.

Additional Inherited Members
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 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 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.
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 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	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.
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

IOFactory interface for reading and writing MagneticCalibrationData to files.

Definition at line 15 of file MagneticCalibration.h.

Member Function Documentation

◆ factoryFeatures()

virtual FactoryFeatures MagneticCalibrationFactory::factoryFeatures	(	const FactoryParameters &	file,
		bool	is_import ) const

overrideprivatevirtual

Returns the feature flags for this factory.

Parameters

[in]	file	The factory parameters.
[in]	is_import	Whether this is for import or export.

Implements IOFactory.

◆ filterModelsToExport()

Buffer< UUID > MagneticCalibrationFactory::filterModelsToExport	(	Buffer< UUID >	models_to_check,
		const DesignObjectLookup *	lookup,
		const FileFormat &	export_format ) const

overrideprivatevirtual

Filters a list of models to only those exportable by this factory.

Parameters

[in]	models_to_check	The models to filter.
[in]	lookup	The design object lookup.
[in]	export_format	The target export format.

Returns: The filtered buffer of exportable model UUIDs.

Reimplemented from IOFactory.

◆ getSupportedFormats()

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

overrideprivatevirtual

Populates the list of supported file formats for reading and writing.

Parameters

[in]	formats	The buffer to populate with supported formats.
[in]	is_read	True for read formats, false for write formats.

Implements IOFactory.

◆ readFile()

bool MagneticCalibrationFactory::readFile ( FactoryParameters & file )

overrideprivatevirtual

Reads magnetic calibration data from a file.

Parameters

[in] file The factory parameters including the file to read.

Returns: True if the file was read successfully.

Implements IOFactory.

◆ writeFile()

bool MagneticCalibrationFactory::writeFile ( FactoryParameters & file )

overrideprivatevirtual

Writes magnetic calibration data to a file.

Parameters

[in] file The factory parameters including the file to write.

Returns: True if the file was written successfully.

Implements IOFactory.

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

Hardware/Headers/MagneticCalibration.h

Private Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ factoryFeatures()

◆ filterModelsToExport()

◆ getSupportedFormats()

◆ readFile()

◆ writeFile()