executorErrorLogger.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_ERROR_LOGGER_H
#define PXR_EXEC_VDF_EXECUTOR_ERROR_LOGGER_H
 
#include "pxr/pxr.h"
 
#include "pxr/exec/vdf/api.h"
#include <tbb/concurrent_unordered_map.h>
#include <atomic>
 
PXR_NAMESPACE_OPEN_SCOPE
 
 
class VdfNode;
 
class VdfExecutorErrorLogger 
{
public:
 
    VDF_API
    VdfExecutorErrorLogger();
 
    VDF_API
    ~VdfExecutorErrorLogger();
 
    using NodeToStringMap =
        tbb::concurrent_unordered_map<const VdfNode *, std::string>;
 
 
    VDF_API
    const NodeToStringMap &GetWarnings() const;
 
    
 
 
    VDF_API
    void ReportWarnings() const;
 
    VDF_API
    static void IssueDefaultWarning(
        const VdfNode &node,
        const std::string &warning);
 
 
 
 
    VDF_API
    void LogWarning(const VdfNode &node, const std::string &warning) const;
 
 
private:
 
    // Holds warnings emitted by nodes during execution.
    mutable std::atomic<NodeToStringMap *> _warnings;
};
 
 
PXR_NAMESPACE_CLOSE_SCOPE
 
#endif