Loading...
Searching...
No Matches
Public Member Functions | List of all members
OutputAccessor Class Reference

A helper class which enables access to a VdfOutput from a VdfContext. More...

#include <testUtils.h>

+ Inheritance diagram for OutputAccessor:

Public Member Functions

 OutputAccessor (const VdfContext &context)
 
const VdfOutput * GetOutput () const
 

Additional Inherited Members

- Protected Member Functions inherited from VdfIterator
 ~VdfIterator ()=default
 Disallow destruction via base class pointers.
 
const VdfNode & _GetNode (const VdfContext &context) const
 Returns the current node being run.
 
const VdfExecutorInterface & _GetExecutor (const VdfContext &context) const
 Returns the executor for the given context.
 
VDF_API const VdfVector * _GetInputValue (const VdfContext &context, const VdfConnection &connection, const VdfMask &mask) const
 Returns a vector for reading an input value.
 
VDF_API const VdfVector & _GetRequiredInputValue (const VdfContext &context, const VdfConnection &connection, const VdfMask &mask) const
 Returns the cached output value for a given output, or issues an error message if a cache value is not available.
 
VDF_API const VdfOutput * _GetRequiredOutputForWriting (const VdfContext &context, const TfToken &name) const
 Returns the output for writing based on the name provided.
 
VDF_API VdfVector * _GetOutputValueForWriting (const VdfContext &context, const VdfOutput &output) const
 Returns a vector for writing an output value into.
 
VDF_API bool _GetOutputMasks (const VdfContext &context, const VdfOutput &output, const VdfMask **requestMask, const VdfMask **affectsMask) const
 Retrieves the request and affects masks of the given output.
 
VDF_API bool _IsRequiredInput (const VdfContext &context, const VdfConnection &connection) const
 Returns true when the connection is scheduled and required, and false otherwise.
 
VDF_API const VdfMask * _GetRequestMask (const VdfContext &context, const VdfOutput &output) const
 Returns the request mask of output, if the output has been scheduled and NULL otherwise.
 
VDF_API void _ForEachScheduledOutput (const VdfContext &context, const VdfNode &node, const VdfScheduledOutputCallback &callback) const
 Loops over each scheduled output of node and calls callback with the output and request mask in an efficient manner.
 

Detailed Description

A helper class which enables access to a VdfOutput from a VdfContext.

Definition at line 118 of file testUtils.h.

Constructor & Destructor Documentation

◆ OutputAccessor()

OutputAccessor ( const VdfContext &  context)
inline

Definition at line 121 of file testUtils.h.

Member Function Documentation

◆ GetOutput()

const VdfOutput * GetOutput ( ) const
inline

Definition at line 123 of file testUtils.h.

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