VersionUpgrader Class Reference

Handles schema version upgrades for MaterialX protobuf documents. More...

#include <materialx_serializer.h>

Static Public Member Functions
static void	upgradeV0ToV1 (MaterialXDocument &pb_doc)
	Example upgrade from version 0.x to 1.x.
static void	upgradeV1ToV2 (MaterialXDocument &pb_doc)
	Example upgrade from version 1.x to 2.x.
static std::string	getVersionString (const MaterialXDocument &pb_doc)
	Get version as a string (e.g., "1.0.0")
static int	compareVersions (uint32_t v1_major, uint32_t v1_minor, uint32_t v1_patch, uint32_t v2_major, uint32_t v2_minor, uint32_t v2_patch)
	Compare two versions.

Detailed Description

Handles schema version upgrades for MaterialX protobuf documents.

• Add upgrade methods for each major version transition.
• Upgrade methods should modify the protobuf message in-place or return a new one.

Member Function Documentation

compareVersions()

int VersionUpgrader::compareVersions ( uint32_t v1_major, uint32_t v1_minor, uint32_t v1_patch, uint32_t v2_major, uint32_t v2_minor, uint32_t v2_patch )

static

Compare two versions.

Returns

-1 if v1 < v2, 0 if equal, 1 if v1 > v2

                                                                                              {
    if (v1_major != v2_major) {
        return (v1_major < v2_major) ? -1 : 1;
    }
    if (v1_minor != v2_minor) {
        return (v1_minor < v2_minor) ? -1 : 1;
    }
    if (v1_patch != v2_patch) {
        return (v1_patch < v2_patch) ? -1 : 1;
    }
    return 0;
}

getVersionString()

std::string VersionUpgrader::getVersionString ( const MaterialXDocument & pb_doc )

static

Get version as a string (e.g., "1.0.0")

Parameters

pb_doc

Protobuf document.

Returns

Version string.

                                                                           {
    if (pb_doc.has_schema_version()) {
        const Version& v = pb_doc.schema_version();
        std::ostringstream oss;
        oss << v.major() << "." << v.minor() << "." << v.patch();
        return oss.str();
    }
    return "unknown";
}

upgradeV0ToV1()

void VersionUpgrader::upgradeV0ToV1 ( MaterialXDocument & pb_doc )

static

Example upgrade from version 0.x to 1.x.

Parameters

pb_doc

The protobuf document to upgrade (modified in-place).

                                                             {
    // Example: If v1 added a new required field, set defaults here
    // Currently no upgrade needed
}

upgradeV1ToV2()

void VersionUpgrader::upgradeV1ToV2 ( MaterialXDocument & pb_doc )

static

Example upgrade from version 1.x to 2.x.

Parameters

pb_doc

The protobuf document to upgrade (modified in-place).

                                                             {
    // Example: If v2 renamed a field, copy old to new
    // Currently no upgrade needed
}

---

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

• materialx_serializer.h
• source/materialx_serializer.py
• build/lib/materialx_serializer.py
• materialx_serializer.cpp