HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Exec_RequestImpl Class Reference

#include <requestImpl.h>

Public Member Functions

void DidInvalidateComputedValues (const Exec_AttributeValueInvalidationResult &invalidationResult)
 
void DidInvalidateComputedValues (const Exec_MetadataInvalidationResult &invalidationResult)
 
void DidInvalidateComputedValues (const Exec_DisconnectedInputsInvalidationResult &invalidationResult)
 
void DidInvalidateUnknownValues ()
 
void DidChangeTime (const Exec_TimeChangeInvalidationResult &invalidationResult)
 Notify the request of time having changed. More...
 
void Expire ()
 

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 ~Exec_RequestImpl ()
 
EXEC_API void _Compile (TfSpan< const ExecValueKey > valueKeys)
 Compiles outputs for the value keys in the request. More...
 
EXEC_API void _Schedule ()
 Builds the schedule for the request. More...
 
EXEC_API Exec_CacheView _Compute ()
 Computes the value keys in the request. More...
 
EXEC_API Exec_CacheView _ComputeWithOverrides (ExecValueOverrideVector &&valueOverrides)
 
EXEC_API bool _RequiresCompilation () const
 
EXEC_API void _ExpireIndices (const ExecRequestIndexSet &expired)
 
EXEC_API void _Discard ()
 

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.

Constructor & Destructor Documentation

EXEC_API Exec_RequestImpl::Exec_RequestImpl ( ExecSystem system,
ExecRequestComputedValueInvalidationCallback &&  valueCallback,
ExecRequestTimeChangeInvalidationCallback &&  timeCallback 
)
protected
Exec_RequestImpl::Exec_RequestImpl ( const Exec_RequestImpl )
protecteddelete
EXEC_API Exec_RequestImpl::~Exec_RequestImpl ( )
protected

Member Function Documentation

EXEC_API void Exec_RequestImpl::_Compile ( TfSpan< const ExecValueKey valueKeys)
protected

Compiles outputs for the value keys in the request.

EXEC_API Exec_CacheView Exec_RequestImpl::_Compute ( )
protected

Computes the value keys in the request.

EXEC_API Exec_CacheView Exec_RequestImpl::_ComputeWithOverrides ( ExecValueOverrideVector &&  valueOverrides)
protected

Computes the value keys in the request in the presence of the provided valueOverrides.

EXEC_API void Exec_RequestImpl::_Discard ( )
protected

Removes the request from the system.

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

EXEC_API void Exec_RequestImpl::_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.

EXEC_API bool Exec_RequestImpl::_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.

EXEC_API void Exec_RequestImpl::_Schedule ( )
protected

Builds the schedule for the request.

void Exec_RequestImpl::DidChangeTime ( const Exec_TimeChangeInvalidationResult &  invalidationResult)

Notify the request of time having changed.

void Exec_RequestImpl::DidInvalidateComputedValues ( const Exec_AttributeValueInvalidationResult &  invalidationResult)

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

void Exec_RequestImpl::DidInvalidateComputedValues ( const Exec_MetadataInvalidationResult &  invalidationResult)

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

void Exec_RequestImpl::DidInvalidateComputedValues ( const Exec_DisconnectedInputsInvalidationResult &  invalidationResult)

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

void Exec_RequestImpl::DidInvalidateUnknownValues ( )

Notify the request to invalidate value keys that don't have a compiled leaf node.

void Exec_RequestImpl::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.

Exec_RequestImpl& Exec_RequestImpl::operator= ( const Exec_RequestImpl )
protecteddelete

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