Loading...
Searching...
No Matches
Exec_RequestImpl Class Reference

Contains data structures necessary to implement exec requests that are independent of scene description. More...

#include <requestImpl.h>

Public Member Functions

void DidInvalidateComputedValues (const Exec_AttributeValueInvalidationResult &invalidationResult)
 Notify the request of invalid computed values as a consequence of attribute authored value invalidation.
 
void DidInvalidateComputedValues (const Exec_MetadataInvalidationResult &invalidationResult)
 Notify the request of invalid computed values as a consequence of metadata authored value invalidation.
 
void DidInvalidateComputedValues (const Exec_DisconnectedInputsInvalidationResult &invalidationResult)
 Notify the request of invalid computed values as a consequence of uncompilation.
 
void DidChangeTime (const Exec_TimeChangeInvalidationResult &invalidationResult)
 Notify the request of time having changed.
 
void Expire ()
 Expires all request indices and discards the request.
 

Protected Member Functions

EXEC_API Exec_RequestImpl (ExecSystem *system, ExecRequestComputedValueInvalidationCallback &&valueCallback, ExecRequestTimeChangeInvalidationCallback &&timeCallback)
 
 Exec_RequestImpl (const Exec_RequestImpl &)=delete
 
Exec_RequestImploperator= (const Exec_RequestImpl &)=delete
 
EXEC_API void _Compile (TfSpan< const ExecValueKey > valueKeys)
 Compiles outputs for the value keys in the request.
 
EXEC_API void _Schedule ()
 Builds the schedule for the request.
 
EXEC_API Exec_CacheView _Compute ()
 Computes the value keys in the request.
 
EXEC_API bool _RequiresCompilation () const
 Returns true if the request needs to be compiled.
 
EXEC_API void _ExpireIndices (const ExecRequestIndexSet &expired)
 Expires the indices in expired.
 
EXEC_API void _Discard ()
 Removes the request from the system.
 

Detailed Description

Contains data structures necessary to implement exec requests that are independent of scene description.

Concrete implementations inherit from Exec_RequestImpl to implement any functionality that is specific to the scene description system.

Definition at line 46 of file requestImpl.h.

Member Function Documentation

◆ _Compile()

EXEC_API void _Compile ( TfSpan< const ExecValueKey valueKeys)
protected

Compiles outputs for the value keys in the request.

◆ _Compute()

EXEC_API Exec_CacheView _Compute ( )
protected

Computes the value keys in the request.

◆ _Discard()

EXEC_API void _Discard ( )
protected

Removes the request from the system.

This prevents any further notification and releases internal request data structures.

◆ _ExpireIndices()

EXEC_API void _ExpireIndices ( const ExecRequestIndexSet expired)
protected

Expires the indices in expired.

Invalidation callbacks will be invoked for these indices one final time. No values will be extractable and no further invalidation will be sent for these indices.

◆ _RequiresCompilation()

EXEC_API bool _RequiresCompilation ( ) const
protected

Returns true if the request needs to be compiled.

A request may skip compilation if its schedule is up-to-date and there is no pending recompilation in the network.

◆ _Schedule()

EXEC_API void _Schedule ( )
protected

Builds the schedule for the request.

◆ DidChangeTime()

void DidChangeTime ( const Exec_TimeChangeInvalidationResult &  invalidationResult)

Notify the request of time having changed.

◆ DidInvalidateComputedValues() [1/3]

void DidInvalidateComputedValues ( const Exec_AttributeValueInvalidationResult &  invalidationResult)

Notify the request of invalid computed values as a consequence of attribute authored value invalidation.

◆ DidInvalidateComputedValues() [2/3]

void DidInvalidateComputedValues ( const Exec_DisconnectedInputsInvalidationResult &  invalidationResult)

Notify the request of invalid computed values as a consequence of uncompilation.

◆ DidInvalidateComputedValues() [3/3]

void DidInvalidateComputedValues ( const Exec_MetadataInvalidationResult &  invalidationResult)

Notify the request of invalid computed values as a consequence of metadata authored value invalidation.

◆ Expire()

void Expire ( )

Expires all request indices and discards the request.

Sends value invalidation for all indicies over all time and renders the request unusuable for any future operation.


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