vtkExodusIICache Class Reference

#include <vtkExodusIICache.h>

Inheritance diagram for vtkExodusIICache:

Collaboration diagram for vtkExodusIICache:

Public Types
typedef vtkObject	Superclass

Public Member Functions
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.
vtkExodusIICache *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
void	Clear ()
	Empty the cache.
void	SetCacheCapacity (double sizeInMiB)
	Set the maximum allowable cache size.
double	GetSpaceLeft ()
	See how much cache space is left.
int	ReduceToSize (double newSize)
	Remove cache entries until the size of the cache is at or below the given size.
void	Insert (vtkExodusIICacheKey &key, vtkDataArray *value)
	Insert an entry into the cache (this can remove other cache entries to make space).
vtkDataArray *&	Find (const vtkExodusIICacheKey &)
	Determine whether a cache entry exists.
int	Invalidate (const vtkExodusIICacheKey &key)
	Invalidate a cache entry (drop it from the cache) if the key exists.
int	Invalidate (const vtkExodusIICacheKey &key, const vtkExodusIICacheKey &pattern)
	Invalidate all cache entries matching a specified pattern, dropping all matches from the cache.
Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)
virtual void	DebugOn ()
	Turn debugging output on.
virtual void	DebugOff ()
	Turn debugging output off.
bool	GetDebug ()
	Get the value of the debug flag.
void	SetDebug (bool debugFlag)
	Set the value of the debug flag.
virtual void	Modified ()
	Update the modification time for this object.
virtual vtkMTimeType	GetMTime ()
	Return this object's modified time.
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
void	RemoveObserver (unsigned long tag)
void	RemoveObservers (unsigned long event)
void	RemoveObservers (const char *event)
void	RemoveAllObservers ()
vtkTypeBool	HasObserver (unsigned long event)
vtkTypeBool	HasObserver (const char *event)
int	InvokeEvent (unsigned long event)
int	InvokeEvent (const char *event)
unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
unsigned long	AddObserver (const char *event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObservers (const char *event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkTypeBool	HasObserver (const char *event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events.
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events.
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
	Allow user to set the AbortFlagOn() with the return value of the callback method.
int	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not.
int	InvokeEvent (const char *event, void *callData)
	This method invokes an event and return whether the event was aborted or not.
Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string.
virtual vtkTypeBool	IsA (const char *name)
	Return 1 if this class is the same type of (or a subclass of) the named class.
virtual vtkIdType	GetNumberOfGenerationsFromBase (const char *name)
	Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
virtual void	Delete ()
	Delete a VTK object.
virtual void	FastDelete ()
	Delete a reference to this object.
void	InitializeObjectBase ()
void	Print (ostream &os)
	Print an object to an ostream.
virtual void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object).
virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object).
int	GetReferenceCount ()
	Return the current reference count of this object.
void	SetReferenceCount (int)
	Sets the reference count.
bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space.
virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.

Static Public Member Functions
static vtkExodusIICache *	New ()
static vtkTypeBool	IsTypeOf (const char *type)
static vtkExodusIICache *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
static void	BreakOnError ()
	This method is called when vtkErrorMacro executes.
static void	SetGlobalWarningDisplay (int val)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static int	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)
	Return 1 if this class type is the same type of (or a subclass of) the named class.
static vtkIdType	GetNumberOfGenerationsFromBaseType (const char *name)
	Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.
static bool	GetUsingMemkind ()
	A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkExodusIICache ()
	Default constructor.
	~vtkExodusIICache () override
	Destructor.
void	RecomputeSize ()
	Avoid (some) FP problems.
Protected Member Functions inherited from vtkObject
	vtkObject ()
	~vtkObject () override
void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
void	InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
	These methods allow a command to exclusively grab all events.
void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events.
Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()
virtual	~vtkObjectBase ()
virtual void	RegisterInternal (vtkObjectBase *, vtkTypeBool check)
virtual void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)
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.
double	Size
	The current size of the cache (i.e., the size of the all the arrays it currently contains) in MiB.
vtkExodusIICacheSet	Cache
	A least-recently-used (LRU) cache to hold arrays.
vtkExodusIICacheLRU	LRU
	The actual LRU list (indices into the cache ordered least to most recently used).
Protected Attributes inherited from vtkObject
bool	Debug
vtkTimeStamp	MTime
vtkSubjectHelper *	SubjectHelper
Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount
vtkWeakPointerBase **	WeakPointers

Additional Inherited Members
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()
static vtkReallocingFunction	GetCurrentReallocFunction ()
static vtkFreeingFunction	GetCurrentFreeFunction ()
static vtkFreeingFunction	GetAlternateFreeFunction ()

Detailed Description

Definition at line 120 of file vtkExodusIICache.h.

Member Typedef Documentation

Superclass

typedef vtkObject vtkExodusIICache::Superclass

Definition at line 124 of file vtkExodusIICache.h.

Constructor & Destructor Documentation

vtkExodusIICache()

vtkExodusIICache::vtkExodusIICache ( )

protected

Default constructor.

~vtkExodusIICache()

vtkExodusIICache::~vtkExodusIICache ( )

overrideprotected

Destructor.

Member Function Documentation

New()

static vtkExodusIICache * vtkExodusIICache::New ( )

static

IsTypeOf()

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

static

IsA()

virtual vtkTypeBool 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 vtkObjectBase.

SafeDownCast()

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

static

NewInstanceInternal()

virtual vtkObjectBase * vtkExodusIICache::NewInstanceInternal ( ) const

protectedvirtual

NewInstance()

vtkExodusIICache * vtkExodusIICache::NewInstance

(

)

const

PrintSelf()

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

overridevirtual

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.

Clear()

void vtkExodusIICache::Clear

(

)

Empty the cache.

SetCacheCapacity()

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.

GetSpaceLeft()

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 138 of file vtkExodusIICache.h.

ReduceToSize()

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.

Insert()

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

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

Find()

vtkDataArray *& vtkExodusIICache::Find

(

const vtkExodusIICacheKey &

)

Determine whether a cache entry exists.

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

Invalidate() [1/2]

int vtkExodusIICache::Invalidate

(

const 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.

Invalidate() [2/2]

int vtkExodusIICache::Invalidate	(	const vtkExodusIICacheKey &	key,
		const 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.

RecomputeSize()

void vtkExodusIICache::RecomputeSize ( )

protected

Avoid (some) FP problems.

Member Data Documentation

Capacity

double vtkExodusIICache::Capacity

protected

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

Definition at line 181 of file vtkExodusIICache.h.

Size

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 185 of file vtkExodusIICache.h.

Cache

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 193 of file vtkExodusIICache.h.

LRU

vtkExodusIICacheLRU vtkExodusIICache::LRU

protected

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

Definition at line 196 of file vtkExodusIICache.h.

---

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

• IO/Exodus/vtkExodusIICache.h