parallelDataManagerVector.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_PARALLEL_DATA_MANAGER_VECTOR_H
#define PXR_EXEC_VDF_PARALLEL_DATA_MANAGER_VECTOR_H
 
 
#include "pxr/pxr.h"
 
#include "pxr/exec/vdf/api.h"
#include "pxr/exec/vdf/parallelExecutorDataManager.h"
#include "pxr/exec/vdf/parallelExecutorDataVector.h"
#include "pxr/exec/vdf/types.h"
 
PXR_NAMESPACE_OPEN_SCOPE
 
class VdfExecutorBufferData;
class VdfExecutorInvalidationData;
class VdfNetwork;
class VdfParallelDataManagerVector;
 
template<>
struct Vdf_ParallelExecutorDataManagerTraits<VdfParallelDataManagerVector> {
 
    typedef Vdf_ParallelExecutorDataVector::DataHandle DataHandle;
 
};
 
class VDF_API_TYPE VdfParallelDataManagerVector : 
    public VdfParallelExecutorDataManager<VdfParallelDataManagerVector>
{
public:
 
    typedef
        VdfParallelExecutorDataManager<VdfParallelDataManagerVector>
        Base;
 
    typedef
        typename Vdf_ParallelExecutorDataManagerTraits<
            VdfParallelDataManagerVector>::DataHandle
        DataHandle;
 
    VdfParallelDataManagerVector() : _data(nullptr) {}
 
    VDF_API
    ~VdfParallelDataManagerVector();
 
    VDF_API
    void Resize(const VdfNetwork &network);
 
    bool IsValidDataHandle(const DataHandle handle) const {
        return handle != Vdf_ParallelExecutorDataVector::InvalidHandle;
    }
 
    inline DataHandle GetOrCreateDataHandle(const VdfId outputId) const {
        return _data->GetOrCreateDataHandle(outputId);
    }
 
    inline DataHandle GetDataHandle(const VdfId outputId) const {
        return _data
            ? _data->GetDataHandle(outputId)
            : Vdf_ParallelExecutorDataVector::InvalidHandle;
    }
 
    VdfExecutorBufferData *GetPrivateBufferData(const DataHandle handle) const {
        return _data->GetPrivateBufferData(handle);
    }
 
    VdfExecutorBufferData *GetScratchBufferData(const DataHandle handle) const {
        return _data->GetScratchBufferData(handle);
    }
 
    VdfExecutorBufferData *GetPublicBufferData(const DataHandle handle) const {
        return _data->GetPublicBufferData(handle);
    }
 
    void PublishPrivateBufferData(const DataHandle handle) const {
        _data->PublishPrivateBufferData(handle);
    }
 
    void PublishScratchBufferData(const DataHandle handle) const {
        _data->PublishScratchBufferData(handle);
    }
 
    VdfExecutorBufferData *GetTransferredBufferData(
        const DataHandle handle) const {
        return _data->GetTransferredBufferData(handle);
    }
 
    bool TransferBufferData(
        const DataHandle handle,
        VdfVector *value,
        const VdfMask &mask) {
        return _data->TransferBufferData(handle, value, mask);
    }
 
    void ResetTransferredBufferData(const DataHandle handle) {
        _data->ResetTransferredBufferData(handle);
    }
 
    VdfExecutorInvalidationData *GetInvalidationData(
        const DataHandle handle) const {
        return _data->GetInvalidationData(handle);
    }
 
    using Base::GetInvalidationTimestamp;
 
    VdfInvalidationTimestamp GetInvalidationTimestamp(
        const DataHandle handle) const {
        return _data->GetInvalidationTimestamp(handle);
    }
 
    void SetInvalidationTimestamp(
        const DataHandle handle,
        VdfInvalidationTimestamp timestamp) {
        _data->SetInvalidationTimestamp(handle, timestamp);
    }
 
    bool IsTouched(const VdfId outputId) const {
        return _data->IsTouched(outputId);
    }
 
    void Touch(const VdfId outputId) const {
        _data->Touch(outputId);
    }
 
    bool Untouch(const VdfId outputId) {
        return _data->Untouch(outputId);
    }
 
    VDF_API
    void ClearDataForOutput(const VdfId outputId);
 
    VDF_API
    void Clear();
 
    bool IsEmpty() const {
        return !_data || _data->GetNumData() == 0;
    }
 
 
private:
 
    // Pointer the the executor data vector.
    mutable Vdf_ParallelExecutorDataVector *_data;
 
};
 
 
PXR_NAMESPACE_CLOSE_SCOPE
 
#endif