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

Organizes output-to-value caches into logical groups, called pages. Pages are keyed off of VdfVector values, such as for example, time values. More...

#include <pageCache.h>

Public Types

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

Public Member Functions

EF_API ~Ef_PageCache ()
 
EF_API Ef_OutputValueCache * Get (const VdfVector &key) const
 
EF_API Ef_OutputValueCache * GetOrCreate (const VdfVector &key)
 
EF_API size_t Clear ()
 
iterator begin ()
 
iterator end ()
 

Static Public Member Functions

template<typename T >
static Ef_PageCache * New ()
 

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

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

Type of the cache map.

Definition at line 69 of file pageCache.h.

typedef CacheMap::iterator Ef_PageCache::iterator

Type of the cache map iterator.

Definition at line 75 of file pageCache.h.

Constructor & Destructor Documentation

EF_API Ef_PageCache::~Ef_PageCache ( )

Destructor.

Member Function Documentation

iterator Ef_PageCache::begin ( void  )
inline

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

Definition at line 79 of file pageCache.h.

EF_API size_t Ef_PageCache::Clear ( )

Clear the entire page cache.

iterator Ef_PageCache::end ( void  )
inline

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

Definition at line 85 of file pageCache.h.

EF_API Ef_OutputValueCache* Ef_PageCache::Get ( const VdfVector &  key) const

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

EF_API Ef_OutputValueCache* Ef_PageCache::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.

template<typename T >
static Ef_PageCache* 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: