Organizes output-to-value caches into logical groups, called pages. More...

#include <pageCache.h>

Public Types
typedef Ef_VectorKey::Map< Ef_OutputValueCache * >::Type	CacheMap
	Type of the cache map.

typedef CacheMap::iterator	iterator
	Type of the cache map iterator.

Public Member Functions
EF_API	~Ef_PageCache ()
	Destructor.

EF_API Ef_OutputValueCache *	Get (const VdfVector &key) const
	Get the output-to-value cache associated with the given key, if one exists.

EF_API Ef_OutputValueCache *	GetOrCreate (const VdfVector &key)
	Get the output-to-value cache associated with the given key, or create a new, empty output-to-value cache if one does not already exist.

EF_API size_t	Clear ()
	Clear the entire page cache.

iterator	begin ()
	Returns an iterator to the output-to-value cache in the first page.

iterator	end ()
	Returns an iterator past the output-to-value cache in the last page.

Static Public Member Functions
template<typename T >
static Ef_PageCache *	New ()
	Construct a new Ef_PageCache, which uses VdfVectors holding type T values as keys.

Detailed Description

Organizes output-to-value caches into logical groups, called pages.

Pages are keyed off of VdfVector values, such as for example, time values.

Definition at line 28 of file pageCache.h.

Member Typedef Documentation

◆ CacheMap

Ef_VectorKey::Map<Ef_OutputValueCache*>::Type CacheMap

Type of the cache map.

Definition at line 69 of file pageCache.h.

◆ iterator

CacheMap::iterator iterator

Type of the cache map iterator.

Definition at line 75 of file pageCache.h.

Constructor & Destructor Documentation

◆ ~Ef_PageCache()

EF_API ~Ef_PageCache ( )

Destructor.

Member Function Documentation

◆ begin()

iterator begin ( )

inline

Returns an iterator to the output-to-value cache in the first page.

Definition at line 79 of file pageCache.h.

◆ Clear()

EF_API size_t Clear ( )

Clear the entire page cache.

◆ end()

iterator end ( )

inline

Returns an iterator past the output-to-value cache in the last page.

Definition at line 85 of file pageCache.h.

◆ Get()

EF_API Ef_OutputValueCache * Get ( const VdfVector & key ) const

Get the output-to-value cache associated with the given key, if one exists.

◆ GetOrCreate()

EF_API Ef_OutputValueCache * GetOrCreate ( const VdfVector & key )

Get the output-to-value cache associated with the given key, or create a new, empty output-to-value cache if one does not already exist.

◆ New()

template<typename T >

static Ef_PageCache * New ( )

inlinestatic

Construct a new Ef_PageCache, which uses VdfVectors holding type T values as keys.

The client is responsible for deleting the heap allocated return value.

Definition at line 43 of file pageCache.h.

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

pxr/exec/ef/pageCache.h

Public Types

Public Member Functions

Static Public Member Functions