WorkspaceConversionFunction Struct Reference

#include <ImFusion/GUI/WorkspaceConversion.h>

Structure to describe a conversion of workspace files between different versions. More...

Detailed Description

Structure to describe a conversion of workspace files between different versions.

See also

WorkspaceConversionRegistry

Public Attributes
std::string	name
	String describing the intent of the conversion.
int	version
	Minimum workspace version when the conversion is to be applied.
std::function< bool(Properties &p, const Filesystem::Path &workspaceFile)>	function
	Conversion function applied to a workspace file if its version is less or equal to version.

Member Data Documentation

name

std::string name

String describing the intent of the conversion.

Will be used for log output to provide better traceability of workspace conversions.

version

int version

Minimum workspace version when the conversion is to be applied.

The conversion will be applied if source_version <= version < target_version. The current workspace version is defined by Workspace::WORKSPACE_VERSION

function

std::function<bool(Properties& p, const Filesystem::Path& workspaceFile)> function

Conversion function applied to a workspace file if its version is less or equal to version.

The function may alter the Properties directly. The return value indicates whether any changes took place. The provided absolute workspace file path may be used to resolve relative paths in the workspace.

---

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

• ImFusion/GUI/WorkspaceConversion.h