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

#include <context.h>

Public Member Functions

 VdfContext (const VdfContext &rhs)=delete
 
VdfContext & operator= (const VdfContext &rhs)=delete
 
 VdfContext (const VdfEvaluationState &state, const VdfNode &node)
 
 VdfContext (const VdfEvaluationState &state, const VdfNode &node, const VdfScheduleTaskIndex invocation)
 
template<typename T >
VdfByValueOrConstRef< T > GetInputValue (const TfToken &name) const
 
template<typename T >
const T * GetInputValuePtr (const TfToken &name) const
 
template<typename T >
const T * GetInputValuePtr (const TfToken &name, const T *defPtr) const
 
template<typename T >
bool HasInputValue (const TfToken &name) const
 
VDF_API bool IsOutputRequested (const TfToken &outputName) const
 
template<typename T >
void SetOutput (const TfToken &outputName, const T &value) const
 
template<typename T >
void SetOutput (const T &value) const
 
template<typename T >
void SetOutput (T &&value) const
 
template<typename T >
void SetOutput (const TfToken &outputName, T &&value) const
 
VDF_API void SetEmptyOutput () const
 
VDF_API void SetEmptyOutput (const TfToken &outputName) const
 
VDF_API void SetOutputToReferenceInput (const TfToken &inputName) const
 
Error Reporting
VDF_API void Warn (const char *fmt,...) const ARCH_PRINTF_FUNCTION(2
 
Debugging
VDF_API std::string GetNodeDebugName () const
 
VDF_API void CodingError (const char *fmt,...) const ARCH_PRINTF_FUNCTION(2
 

Friends

class VdfIterator
 
class VdfSpeculationNode
 

Detailed Description

A context is the parameter bundle passed to callbacks of computations. It is the only API through which functions have access to their inputs.

Definition at line 39 of file context.h.

Constructor & Destructor Documentation

VdfContext::VdfContext ( const VdfContext &  rhs)
delete
VdfContext::VdfContext ( const VdfEvaluationState &  state,
const VdfNode &  node 
)
inline

Constructs a VdfContext for the given node with the current evaluation state.

Definition at line 50 of file context.h.

VdfContext::VdfContext ( const VdfEvaluationState &  state,
const VdfNode &  node,
const VdfScheduleTaskIndex  invocation 
)
inline

Constructs a VdfContext for the given node and node invocation with the current evaluation state.

Definition at line 59 of file context.h.

Member Function Documentation

VDF_API void VdfContext::CodingError ( const char *  fmt,
  ... 
) const

Invokes a coding error with an error message and a graph around the node that this context is currently referencing. It takes a printf-style format specification.

template<typename T >
VdfByValueOrConstRef< T > VdfContext::GetInputValue ( const TfToken &  name) const
inline

Returns a value from the input named name of type T. This method assumes that the caller expects only a single value to exist on its input.

Definition at line 300 of file context.h.

template<typename T >
const T * VdfContext::GetInputValuePtr ( const TfToken &  name) const
inline

Returns a pointer to the value from the input named name if the input has a valid value, otherwise returns nullptr.

Definition at line 319 of file context.h.

template<typename T >
const T * VdfContext::GetInputValuePtr ( const TfToken &  name,
const T *  defPtr 
) const
inline

Returns a pointer to the value from the input named name if the input has a valid value, otherwise returns defPtr.

Definition at line 326 of file context.h.

VDF_API std::string VdfContext::GetNodeDebugName ( ) const

Returns the debug name for the node for this context.

template<typename T >
bool VdfContext::HasInputValue ( const TfToken &  name) const
inline

Returns true, if there are input values from the input named name of type T.

Definition at line 334 of file context.h.

VDF_API bool VdfContext::IsOutputRequested ( const TfToken &  outputName) const

Returns true if the output named outputName is requested by at least one downstream node, or false if there are no consumers for the output or if outputName isn't a valid output on this node.

This can be used by the node callback to avoid computing expensive outputs that are not needed.

NOTE: It's far preferred for computations to be designed with appropriate granularity, but this may be used in cases where the computation of multiple outputs isn't feasibly separable.

VdfContext& VdfContext::operator= ( const VdfContext &  rhs)
delete
VDF_API void VdfContext::SetEmptyOutput ( ) const

Sets an empty value on the output.

It is invalid to call this method on any node that does not have exactly one output.

VDF_API void VdfContext::SetEmptyOutput ( const TfToken &  outputName) const

Sets an empty value on the output named outputName.

template<typename T >
void VdfContext::SetOutput ( const TfToken &  outputName,
const T &  value 
) const
inline

Sets the value of the output named outputName to value.

This can be used when the node already has all the answers and doesn't want to bother with iterators.

Note that this method currently always performs a full copy, because it can't tell if we are allowed to take ownership of the given output.

Definition at line 394 of file context.h.

template<typename T >
void VdfContext::SetOutput ( const T &  value) const
inline

Sets the value of the output to value.

This can be used when the node already has all the answers and doesn't want to bother with iterators.

Note that this method currently always performs a full copy, because it can't tell if we are allowed to take ownership of the given output.

It is invalid to call this method on any node that does not have exactly one output.

Definition at line 409 of file context.h.

template<typename T >
void VdfContext::SetOutput ( T &&  value) const
inline

Sets the value of the output to value.

This can be used when the node already has all the answers and doesn't want to bother with iterators.

This method moves the data into the output, and thus avoids a copy. However, note that value will no longer contain any meaningful data after this method returned.

It is invalid to call this method on any node that does not have exactly one output.

Definition at line 424 of file context.h.

template<typename T >
void VdfContext::SetOutput ( const TfToken &  outputName,
T &&  value 
) const
inline

Sets the value of the output named outputName to value.

This can be used when the node already has all the answers and doesn't want to bother with iterators.

This method moves the data into the output, and thus avoids a copy. However, note that value will no longer contain any meaningful data after this method returned.

Definition at line 440 of file context.h.

VDF_API void VdfContext::SetOutputToReferenceInput ( const TfToken &  inputName) const

Sets the one and only output to have the same output value as the value on the output connected to input inputName.

Calling this method when the input doesn't need to be modified gives the system an opportunity to apply some optimizations when possible.

Note that this optimization might not take effect in certain circumstances.

VDF_API void VdfContext::Warn ( const char *  fmt,
  ... 
) const

Reports a warning to the system that was encountered at runtime.

Exactly how the warning is presented to the user, if at all, is up to the host system.

Multiple calls to Warn() from the same node will cause the messages to be concatenated.

Friends And Related Function Documentation

friend class VdfIterator
friend

Definition at line 222 of file context.h.

friend class VdfSpeculationNode
friend

Definition at line 233 of file context.h.

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