executorDataManagerInterface.h

Go to the documentation of this file.

//
// Copyright 2025 Pixar
//
// Licensed under the terms set forth in the LICENSE.txt file available at
// https://openusd.org/license.
//
#ifndef PXR_EXEC_VDF_EXECUTOR_DATA_MANAGER_INTERFACE_H
#define PXR_EXEC_VDF_EXECUTOR_DATA_MANAGER_INTERFACE_H


#include "pxr/pxr.h"

#include "pxr/exec/vdf/types.h"

PXR_NAMESPACE_OPEN_SCOPE

class VdfExecutorBufferData;
class VdfExecutorInvalidationData;
class VdfNetwork;
class VdfOutput;
class VdfSMBLData;


template <typename DerivedClass, typename DataHandle>
class Vdf_ExecutorDataManagerInterface 
{
protected:

    Vdf_ExecutorDataManagerInterface() = default;

    ~Vdf_ExecutorDataManagerInterface() = default;

    void _Resize(const VdfNetwork &network) {
        _Self()->Resize(network);
    }

    bool _IsValidDataHandle(const DataHandle handle) const {
        return _Self()->IsValidDataHandle(handle);
    }

    DataHandle _GetOrCreateDataHandle(const VdfId outputId) const {
        return _Self()->GetOrCreateDataHandle(outputId);
    }

    DataHandle _GetDataHandle(const VdfId outputId) const {
        return _Self()->GetDataHandle(outputId);
    }

    VdfExecutorBufferData * _GetBufferData(const DataHandle handle) const {
        return _Self()->GetBufferData(handle);
    }

    VdfExecutorInvalidationData * _GetInvalidationData(
        const DataHandle handle) const {
        return _Self()->GetInvalidationData(handle);
    }

    VdfInvalidationTimestamp _GetInvalidationTimestamp(
        const DataHandle handle) const {
        return _Self()->GetInvalidationTimestamp(handle);
    }

    void _SetInvalidationTimestamp(
        const DataHandle handle,
        VdfInvalidationTimestamp ts) {
        _Self()->SetInvalidationTimestamp(handle, ts);
    }

    VdfSMBLData * _GetSMBLData(const DataHandle handle) const {
        return _Self()->GetSMBLData(handle);
    }

    VdfSMBLData * _GetOrCreateSMBLData(const DataHandle handle) const {
        return _Self()->GetOrCreateSMBLData(handle);
    }

    bool _IsTouched(const DataHandle handle) const {
        return _Self()->IsTouched(handle);
    }

    void _Touch(const DataHandle handle) const {
        _Self()->Touch(handle);
    }

    bool _Untouch(const DataHandle handle) {
        return _Self()->Untouch(handle);
    }

    void _ClearDataForOutput(const VdfOutput &output) {
        return _Self()->ClearDataForOutput(output);
    }

private:

    // Returns the constant this pointer to the derived class.
    const DerivedClass * _Self() const {
        return static_cast<const DerivedClass *>(this);
    }


    // Returns the mutable this pointer to the derived class.
    DerivedClass * _Self() {
        return static_cast<DerivedClass *>(this);
    }

};

PXR_NAMESPACE_CLOSE_SCOPE

#endif