vtkExodusIICache Class Reference

#include <vtkExodusIICache.h>

Inheritance diagram for vtkExodusIICache:

Collaboration diagram for vtkExodusIICache:

Public Types
typedef vtkObject	Superclass
Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass

Public Member Functions
virtual int	IsA (const char *type)
vtkExodusIICache *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent)
void	Clear ()
	Empty the cache. More...
void	SetCacheCapacity (double sizeInMiB)
	Set the maximum allowable cache size. This will remove cache entries if the capacity is reduced below the current size. More...
double	GetSpaceLeft ()
	See how much cache space is left. More...
int	ReduceToSize (double newSize)
	Remove cache entries until the size of the cache is at or below the given size. More...
void	Insert (vtkExodusIICacheKey &key, vtkDataArray *value)
	Insert an entry into the cache (this can remove other cache entries to make space). More...
vtkDataArray *&	Find (vtkExodusIICacheKey)
	Determine whether a cache entry exists. More...
int	Invalidate (vtkExodusIICacheKey key)
	Invalidate a cache entry (drop it from the cache) if the key exists. More...
int	Invalidate (vtkExodusIICacheKey key, vtkExodusIICacheKey pattern)
	Invalidate all cache entries matching a specified pattern, dropping all matches from the cache. More...
Public Member Functions inherited from vtkObject
vtkObject *	NewInstance () const
virtual void	DebugOn ()
virtual void	DebugOff ()
bool	GetDebug ()
void	SetDebug (bool debugFlag)
virtual void	Modified ()
virtual unsigned long	GetMTime ()
unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
unsigned long	AddObserver (const char *event, vtkCommand *, float priority=0.0f)
vtkCommand *	GetCommand (unsigned long tag)
void	RemoveObserver (vtkCommand *)
void	RemoveObservers (unsigned long event, vtkCommand *)
void	RemoveObservers (const char *event, vtkCommand *)
int	HasObserver (unsigned long event, vtkCommand *)
int	HasObserver (const char *event, vtkCommand *)
void	RemoveObserver (unsigned long tag)
void	RemoveObservers (unsigned long event)
void	RemoveObservers (const char *event)
void	RemoveAllObservers ()
int	HasObserver (unsigned long event)
int	HasObserver (const char *event)
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
int	InvokeEvent (unsigned long event, void *callData)
int	InvokeEvent (const char *event, void *callData)
int	InvokeEvent (unsigned long event)
int	InvokeEvent (const char *event)
Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
virtual void	Delete ()
virtual void	FastDelete ()
void	Print (ostream &os)
virtual void	Register (vtkObjectBase *o)
virtual void	UnRegister (vtkObjectBase *o)
void	SetReferenceCount (int)
void	PrintRevisions (ostream &)
virtual void	PrintHeader (ostream &os, vtkIndent indent)
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
int	GetReferenceCount ()

Static Public Member Functions
static vtkExodusIICache *	New ()
static int	IsTypeOf (const char *type)
static vtkExodusIICache *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkObject
static int	IsTypeOf (const char *type)
static vtkObject *	SafeDownCast (vtkObjectBase *o)
static vtkObject *	New ()
static void	BreakOnError ()
static void	SetGlobalWarningDisplay (int val)
static void	GlobalWarningDisplayOn ()
static void	GlobalWarningDisplayOff ()
static int	GetGlobalWarningDisplay ()
Static Public Member Functions inherited from vtkObjectBase
static int	IsTypeOf (const char *name)
static vtkObjectBase *	New ()

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkExodusIICache ()
	Default constructor. More...
	~vtkExodusIICache ()
	Destructor. More...
void	RecomputeSize ()
	Avoid (some) FP problems. More...
Protected Member Functions inherited from vtkObject
	vtkObject ()
virtual	~vtkObject ()
virtual void	RegisterInternal (vtkObjectBase *, int check)
virtual void	UnRegisterInternal (vtkObjectBase *, int check)
void	InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
void	InternalReleaseFocus ()
Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()
virtual	~vtkObjectBase ()
virtual void	CollectRevisions (ostream &)
virtual void	ReportReferences (vtkGarbageCollector *)
	vtkObjectBase (const vtkObjectBase &)
void	operator= (const vtkObjectBase &)

Protected Attributes
double	Capacity
	The capacity of the cache (i.e., the maximum size of all arrays it contains) in MiB. More...
double	Size
	The current size of the cache (i.e., the size of the all the arrays it currently contains) in MiB. More...
vtkExodusIICacheSet	Cache
	A least-recently-used (LRU) cache to hold arrays. More...
vtkExodusIICacheLRU	LRU
	The actual LRU list (indices into the cache ordered least to most recently used). More...
Protected Attributes inherited from vtkObject
bool	Debug
vtkTimeStamp	MTime
vtkSubjectHelper *	SubjectHelper
Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount
vtkWeakPointerBase **	WeakPointers

Detailed Description

Definition at line 129 of file vtkExodusIICache.h.

Member Typedef Documentation

typedef vtkObject vtkExodusIICache::Superclass

Definition at line 133 of file vtkExodusIICache.h.

Constructor & Destructor Documentation

vtkExodusIICache::vtkExodusIICache ( )

protected

Default constructor.

vtkExodusIICache::~vtkExodusIICache ( )

protected

Destructor.

Member Function Documentation

static vtkExodusIICache* vtkExodusIICache::New ( )

static

static int vtkExodusIICache::IsTypeOf ( const char *  type )

static

virtual int vtkExodusIICache::IsA ( const char *  name )

virtual

Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkObject.

static vtkExodusIICache* vtkExodusIICache::SafeDownCast ( vtkObjectBase *  o )

static

virtual vtkObjectBase* vtkExodusIICache::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkObject.

vtkExodusIICache* vtkExodusIICache::NewInstance

(

)

const

void vtkExodusIICache::PrintSelf ( ostream &  os, vtkIndent  indent  )

virtual

Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkObject.

void vtkExodusIICache::Clear

(

)

Empty the cache.

void vtkExodusIICache::SetCacheCapacity

(

double

sizeInMiB

)

Set the maximum allowable cache size. This will remove cache entries if the capacity is reduced below the current size.

double vtkExodusIICache::GetSpaceLeft ( )

inline

See how much cache space is left.

This is the difference between the capacity and the size of the cache. The result is in MiB.

Definition at line 146 of file vtkExodusIICache.h.

int vtkExodusIICache::ReduceToSize

(

double

newSize

)

Remove cache entries until the size of the cache is at or below the given size.

Returns a nonzero value if deletions were required.

void vtkExodusIICache::Insert	(	vtkExodusIICacheKey &	key,
		vtkDataArray *	value
	)

Insert an entry into the cache (this can remove other cache entries to make space).

vtkDataArray*& vtkExodusIICache::Find

(

vtkExodusIICacheKey

)

Determine whether a cache entry exists.

If it does, return it – otherwise return NULL. If a cache entry exists, it is marked as most recently used.

int vtkExodusIICache::Invalidate

(

vtkExodusIICacheKey

key

)

Invalidate a cache entry (drop it from the cache) if the key exists.

This does nothing if the cache entry does not exist. Returns 1 if the cache entry existed prior to this call and 0 otherwise.

int vtkExodusIICache::Invalidate	(	vtkExodusIICacheKey	key,
		vtkExodusIICacheKey	pattern
	)

Invalidate all cache entries matching a specified pattern, dropping all matches from the cache.

Any nonzero entry in the pattern forces a comparison between the corresponding value of key. Any cache entries satisfying all the comparisons will be dropped. If pattern is entirely zero, this will empty the entire cache. This is useful for invalidating all entries of a given object type.

Returns the number of cache entries dropped. It is not an error to specify an empty range – 0 will be returned if one is given.

void vtkExodusIICache::RecomputeSize ( )

protected

Avoid (some) FP problems.

Member Data Documentation

double vtkExodusIICache::Capacity

protected

The capacity of the cache (i.e., the maximum size of all arrays it contains) in MiB.

Definition at line 193 of file vtkExodusIICache.h.

double vtkExodusIICache::Size

protected

The current size of the cache (i.e., the size of the all the arrays it currently contains) in MiB.

Definition at line 196 of file vtkExodusIICache.h.

vtkExodusIICacheSet vtkExodusIICache::Cache

protected

A least-recently-used (LRU) cache to hold arrays.

During RequestData the cache may contain more than its maximum size since the user may request more data than the cache can hold. However, the cache is expunged whenever a new array is loaded. Never count on the cache holding what you request for very long.

Definition at line 205 of file vtkExodusIICache.h.

vtkExodusIICacheLRU vtkExodusIICache::LRU

protected

The actual LRU list (indices into the cache ordered least to most recently used).

Definition at line 208 of file vtkExodusIICache.h.

---

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

• /home/boeckb/code/depot/group-kitware/vtk/build-release/Utilities/Doxygen/dox/IO/Exodus/vtkExodusIICache.h