VTK  9.1.0
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkExodusIICache Class Reference

#include <vtkExodusIICache.h>

Inheritance diagram for vtkExodusIICache:
[legend]
Collaboration diagram for vtkExodusIICache:
[legend]

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. More...
 
vtkExodusIICacheNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
void Clear ()
 Empty the cache. More...
 
void SetCacheCapacity (double sizeInMiB)
 Set the maximum allowable cache 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 (const vtkExodusIICacheKey &)
 Determine whether a cache entry exists. More...
 
int Invalidate (const vtkExodusIICacheKey &key)
 Invalidate a cache entry (drop it from the cache) if the key exists. More...
 
int Invalidate (const vtkExodusIICacheKey &key, const vtkExodusIICacheKey &pattern)
 Invalidate all cache entries matching a specified pattern, dropping all matches from the cache. More...
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time. More...
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
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. More...
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkCommandGetCommand (unsigned long tag)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObserver (vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
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. More...
 
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. More...
 
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. More...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
int InvokeEvent (const char *event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. More...
 
virtual vtkTypeBool IsA (const char *name)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
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). More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
virtual void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object). More...
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object). More...
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
bool GetIsInMemkind () const
 A local state flag that remembers whether this object lives in the normal or extended memory space. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 

Static Public Member Functions

static vtkExodusIICacheNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkExodusIICacheSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOff ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static int GetGlobalWarningDisplay ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
- 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. More...
 
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). More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void SetMemkindDirectory (const char *directoryname)
 The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. More...
 
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. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkExodusIICache ()
 Default constructor. More...
 
 ~vtkExodusIICache () override
 Destructor. More...
 
void RecomputeSize ()
 Avoid (some) FP problems. More...
 
- 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. More...
 
void InternalReleaseFocus ()
 These methods allow a command to exclusively grab all events. More...
 
- 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. 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
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

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: