HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Types | Public Member Functions | List of all members
VdfExecutorErrorLogger Class Reference

#include <executorErrorLogger.h>

Public Types

using NodeToStringMap = tbb::concurrent_unordered_map< const VdfNode *, std::string >
 

Public Member Functions

VDF_API VdfExecutorErrorLogger ()
 
VDF_API ~VdfExecutorErrorLogger ()
 
Accessors API
VDF_API const NodeToStringMap & GetWarnings () const
 
Logging API
VDF_API void LogWarning (const VdfNode &node, const std::string &warning) const
 

Reporting API

VDF_API void ReportWarnings () const
 
static VDF_API void IssueDefaultWarning (const VdfNode &node, const std::string &warning)
 

Detailed Description

A client may instantiate an object of this class and set it in an executor, to collect errors that may have been reported by nodes during a call to Run() on the executor.

Since since API is used by executors it is partly thread-safe as noted below.

Definition at line 33 of file executorErrorLogger.h.

Member Typedef Documentation

using VdfExecutorErrorLogger::NodeToStringMap = tbb::concurrent_unordered_map<const VdfNode *, std::string>

A thread safe map from node pointer to string for logging warnings.

Definition at line 50 of file executorErrorLogger.h.

Constructor & Destructor Documentation

VDF_API VdfExecutorErrorLogger::VdfExecutorErrorLogger ( )

Ctor.

VDF_API VdfExecutorErrorLogger::~VdfExecutorErrorLogger ( )

Dtor.

Member Function Documentation

VDF_API const NodeToStringMap& VdfExecutorErrorLogger::GetWarnings ( ) const

Returns a map that maps nodes to warning strings that were encountered during a call to Run().

static VDF_API void VdfExecutorErrorLogger::IssueDefaultWarning ( const VdfNode &  node,
const std::string &  warning 
)
static

Prints out default warning message based on node's debug name.

VDF_API void VdfExecutorErrorLogger::LogWarning ( const VdfNode &  node,
const std::string &  warning 
) const

Logs a warning against node. Concatenates existing warnings, if any. This is thread-safe.

VDF_API void VdfExecutorErrorLogger::ReportWarnings ( ) const

Reports warnings using node debug names. Usually a client will want to use GetWarnings() and report more meaningful messages.

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