The interface contract for the static polymorphism used by executor data manager implementations. More...

#include <executorDataManagerInterface.h>

Inheritance diagram for Vdf_ExecutorDataManagerInterface< DerivedClass, DataHandle >:

Protected Member Functions
	Vdf_ExecutorDataManagerInterface ()=default
	Allow construction via derived classes, only.

	~Vdf_ExecutorDataManagerInterface ()=default
	Prevent destruction via base class pointers (static polymorphism only).

void	_Resize (const VdfNetwork &network)
	Resize the data manager to accommodate all the outputs in the given network.

bool	_IsValidDataHandle (const DataHandle handle) const
	Returns `true` if the given data `handle` is valid, i.e.

DataHandle	_GetOrCreateDataHandle (const VdfId outputId) const
	Returns an existing data handle, or creates a new one for the given `outputId`.

DataHandle	_GetDataHandle (const VdfId outputId) const
	Returns an existing data handle for the given `outputId`.

VdfExecutorBufferData *	_GetBufferData (const DataHandle handle) const
	Returns the VdfExecutorBufferData associated with the given `handle`.

VdfExecutorInvalidationData *	_GetInvalidationData (const DataHandle handle) const
	Returns the VdfExecutorInvalidationData associated with the given `handle`.

VdfInvalidationTimestamp	_GetInvalidationTimestamp (const DataHandle handle) const
	Returns the VdfInvalidationTimestamp associated with the given `handle`.

void	_SetInvalidationTimestamp (const DataHandle handle, VdfInvalidationTimestamp ts)
	Sets the invalidation `timestamp` for the give data `handle`.

VdfSMBLData *	_GetSMBLData (const DataHandle handle) const
	Returns an existing `VdfSMBLData` associated with the given `handle`.

VdfSMBLData *	_GetOrCreateSMBLData (const DataHandle handle) const
	Returns an existing `VdfSMBLData` associated with the given `handle` or creates a new one of none exists.

bool	_IsTouched (const DataHandle handle) const
	Returns `true` if the data at the given `handle` has been touched by evaluation.

void	_Touch (const DataHandle handle) const
	Marks the data at the given `handle` as having been touched by evaluation.

bool	_Untouch (const DataHandle handle)
	Marks the data at the given `handle` as not having been touched by evaluation.

void	_ClearDataForOutput (const VdfOutput &output)
	Clears the executor data for a specific output.

Detailed Description

template<typename DerivedClass, typename DataHandle>
class Vdf_ExecutorDataManagerInterface< DerivedClass, DataHandle >

The interface contract for the static polymorphism used by executor data manager implementations.

Definition at line 33 of file executorDataManagerInterface.h.

Constructor & Destructor Documentation

◆ Vdf_ExecutorDataManagerInterface()

Vdf_ExecutorDataManagerInterface ( )

protecteddefault

Allow construction via derived classes, only.

◆ ~Vdf_ExecutorDataManagerInterface()

~Vdf_ExecutorDataManagerInterface ( )

protecteddefault

Prevent destruction via base class pointers (static polymorphism only).

Member Function Documentation

◆ _ClearDataForOutput()

void _ClearDataForOutput ( const VdfOutput & output )

inlineprotected

Clears the executor data for a specific output.

Definition at line 173 of file executorDataManagerInterface.h.

◆ _GetBufferData()

VdfExecutorBufferData * _GetBufferData ( const DataHandle handle ) const

inlineprotected

Returns the VdfExecutorBufferData associated with the given handle.

Note that attempting to retrieve data at an invalid handle need not be supported.

Definition at line 84 of file executorDataManagerInterface.h.

◆ _GetDataHandle()

DataHandle _GetDataHandle ( const VdfId outputId ) const

inlineprotected

Returns an existing data handle for the given outputId.

This method must return an invalid data handle, if no handle has been created for the given outputId.

Definition at line 75 of file executorDataManagerInterface.h.

◆ _GetInvalidationData()

VdfExecutorInvalidationData * _GetInvalidationData ( const DataHandle handle ) const

inlineprotected

Returns the VdfExecutorInvalidationData associated with the given handle.

Note that attempting to retrieve data at an invalid handle need not be supported.

Definition at line 94 of file executorDataManagerInterface.h.

◆ _GetInvalidationTimestamp()

VdfInvalidationTimestamp _GetInvalidationTimestamp ( const DataHandle handle ) const

inlineprotected

Returns the VdfInvalidationTimestamp associated with the given handle.

Note that attempting to retrieve data at an invalid handle need not be supported.

Definition at line 105 of file executorDataManagerInterface.h.

◆ _GetOrCreateDataHandle()

DataHandle _GetOrCreateDataHandle ( const VdfId outputId ) const

inlineprotected

Returns an existing data handle, or creates a new one for the given outputId.

This method must always return a valid data handle.

Definition at line 67 of file executorDataManagerInterface.h.

◆ _GetOrCreateSMBLData()

VdfSMBLData * _GetOrCreateSMBLData ( const DataHandle handle ) const

inlineprotected

Returns an existing VdfSMBLData associated with the given handle or creates a new one of none exists.

Note that this must always return a valid pointer to VdfSMBLData.

Definition at line 137 of file executorDataManagerInterface.h.

◆ _GetSMBLData()

VdfSMBLData * _GetSMBLData ( const DataHandle handle ) const

inlineprotected

Returns an existing VdfSMBLData associated with the given handle.

Returns nullptr if there is no SMBL data associated with this data handle.

Note that attempting to retrieve data at an invalid handle need not be supported.

Definition at line 128 of file executorDataManagerInterface.h.

◆ _IsTouched()

bool _IsTouched ( const DataHandle handle ) const

inlineprotected

Returns true if the data at the given handle has been touched by evaluation.

Note that attempting to touch data at an invalid handle need not be supported.

Definition at line 147 of file executorDataManagerInterface.h.

◆ _IsValidDataHandle()

bool _IsValidDataHandle ( const DataHandle handle ) const

inlineprotected

Returns true if the given data handle is valid, i.e.

it is valid to ask for data for this given handle.

Note that attempting to resolve data at an invalid handle need not be supported.

Definition at line 58 of file executorDataManagerInterface.h.

◆ _Resize()

void _Resize ( const VdfNetwork & network )

inlineprotected

Resize the data manager to accommodate all the outputs in the given network.

Definition at line 48 of file executorDataManagerInterface.h.

◆ _SetInvalidationTimestamp()

void _SetInvalidationTimestamp	(	const DataHandle	handle,
		VdfInvalidationTimestamp	ts
	)

inlineprotected

Sets the invalidation timestamp for the give data handle.

Note that attempting to retrieve data at an invalid handle need not be supported.

Definition at line 115 of file executorDataManagerInterface.h.

◆ _Touch()

void _Touch ( const DataHandle handle ) const

inlineprotected

Marks the data at the given handle as having been touched by evaluation.

Note that attempting to touch data at an invalid handle need not be supported.

Definition at line 157 of file executorDataManagerInterface.h.

◆ _Untouch()

bool _Untouch ( const DataHandle handle )

inlineprotected

Marks the data at the given handle as not having been touched by evaluation.

Returns true if the data has previously been touched.

Note that attempting to un-touch data at an invalid handle need not be supported.

Definition at line 167 of file executorDataManagerInterface.h.

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

pxr/exec/vdf/executorDataManagerInterface.h

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ Vdf_ExecutorDataManagerInterface()

◆ ~Vdf_ExecutorDataManagerInterface()

Member Function Documentation

◆ _ClearDataForOutput()

◆ _GetBufferData()

◆ _GetDataHandle()

◆ _GetInvalidationData()

◆ _GetInvalidationTimestamp()

◆ _GetOrCreateDataHandle()

◆ _GetOrCreateSMBLData()

◆ _GetSMBLData()

◆ _IsTouched()

◆ _IsValidDataHandle()

◆ _Resize()

◆ _SetInvalidationTimestamp()

◆ _Touch()

◆ _Untouch()