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

#include <vtkAMRDataSetCache.h>

Inheritance diagram for vtkAMRDataSetCache:
[legend]
Collaboration diagram for vtkAMRDataSetCache:
[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...
 
vtkAMRDataSetCacheNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
void InsertAMRBlock (int compositeIdx, vtkUniformGrid *amrGrid)
 Inserts an AMR block to the cache. More...
 
void InsertAMRBlockPointData (int compositeIdx, vtkDataArray *dataArray)
 Inserts a point data array to an already cached block NOTE: this->HasAMRBlock( compositeIdx ) == true. More...
 
void InsertAMRBlockCellData (int compositeIdx, vtkDataArray *dataArray)
 Inserts a cell data array to an already cached block NOTE: this->HasAMRBlock( compositeIdx ) == true. More...
 
vtkDataArrayGetAMRBlockCellData (int compositeIdx, const char *dataName)
 Given the name of the cell array and AMR block composite index, this method returns a pointer to the cell data array. More...
 
vtkDataArrayGetAMRBlockPointData (int compositeIdx, const char *dataName)
 Given the name of the point array and AMR block composite index, this method returns a pointer to the point data array. More...
 
vtkUniformGridGetAMRBlock (int compositeIdx)
 Given the composite index, this method returns the AMR block. More...
 
bool HasAMRBlockCellData (int compositeIdx, const char *name)
 Checks if the cell data array, associated with the provided name, has been cached for the AMR block with the given composite index. More...
 
bool HasAMRBlockPointData (int compositeIdx, const char *name)
 Checks if the point data array, associated with the provided name, has been cached for the AMR block with the given composite index. More...
 
bool HasAMRBlock (const int compositeIdx)
 Checks if the AMR block associated with the given composite is cached. 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...
 
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)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
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)
 
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)
 
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)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. 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 PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
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...
 
void PrintRevisions (ostream &)
 Legacy. More...
 

Static Public Member Functions

static vtkAMRDataSetCacheNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkAMRDataSetCacheSafeDownCast (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 ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- 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 vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Types

typedef std::map< int, vtkUniformGrid * > AMRCacheType
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkAMRDataSetCache ()
 
 ~vtkAMRDataSetCache () override
 
- 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 ()
 
- 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

AMRCacheType Cache
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

A concrete implementation of vtkObject that provides functionality for caching AMR blocks. The primary intent of this class is to be used by the AMR reader infrastructure for caching blocks/data in memory to minimize out-of-core operations.

Definition at line 35 of file vtkAMRDataSetCache.h.

Member Typedef Documentation

◆ Superclass

Definition at line 39 of file vtkAMRDataSetCache.h.

◆ AMRCacheType

typedef std::map< int, vtkUniformGrid* > vtkAMRDataSetCache::AMRCacheType
protected

Definition at line 104 of file vtkAMRDataSetCache.h.

Constructor & Destructor Documentation

◆ vtkAMRDataSetCache()

vtkAMRDataSetCache::vtkAMRDataSetCache ( )
protected

◆ ~vtkAMRDataSetCache()

vtkAMRDataSetCache::~vtkAMRDataSetCache ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkAMRDataSetCache* vtkAMRDataSetCache::New ( )
static

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool vtkAMRDataSetCache::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 vtkAMRDataSetCache* vtkAMRDataSetCache::SafeDownCast ( vtkObjectBase o)
static

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkAMRDataSetCache::NewInstanceInternal ( ) const
protectedvirtual

◆ NewInstance()

vtkAMRDataSetCache* vtkAMRDataSetCache::NewInstance ( ) const

◆ PrintSelf()

void vtkAMRDataSetCache::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.

◆ InsertAMRBlock()

void vtkAMRDataSetCache::InsertAMRBlock ( int  compositeIdx,
vtkUniformGrid amrGrid 
)

Inserts an AMR block to the cache.

◆ InsertAMRBlockPointData()

void vtkAMRDataSetCache::InsertAMRBlockPointData ( int  compositeIdx,
vtkDataArray dataArray 
)

Inserts a point data array to an already cached block NOTE: this->HasAMRBlock( compositeIdx ) == true.

◆ InsertAMRBlockCellData()

void vtkAMRDataSetCache::InsertAMRBlockCellData ( int  compositeIdx,
vtkDataArray dataArray 
)

Inserts a cell data array to an already cached block NOTE: this->HasAMRBlock( compositeIdx ) == true.

◆ GetAMRBlockCellData()

vtkDataArray* vtkAMRDataSetCache::GetAMRBlockCellData ( int  compositeIdx,
const char *  dataName 
)

Given the name of the cell array and AMR block composite index, this method returns a pointer to the cell data array.

NOTE: Null is returned if the cell array and/or block is not cached.

◆ GetAMRBlockPointData()

vtkDataArray* vtkAMRDataSetCache::GetAMRBlockPointData ( int  compositeIdx,
const char *  dataName 
)

Given the name of the point array and AMR block composite index, this method returns a pointer to the point data array.

NOTE: Null is returned if the point array and /or block is not cached.

◆ GetAMRBlock()

vtkUniformGrid* vtkAMRDataSetCache::GetAMRBlock ( int  compositeIdx)

Given the composite index, this method returns the AMR block.

NOTE: Null is returned if the AMR block does not exist in the cache.

◆ HasAMRBlockCellData()

bool vtkAMRDataSetCache::HasAMRBlockCellData ( int  compositeIdx,
const char *  name 
)

Checks if the cell data array, associated with the provided name, has been cached for the AMR block with the given composite index.

◆ HasAMRBlockPointData()

bool vtkAMRDataSetCache::HasAMRBlockPointData ( int  compositeIdx,
const char *  name 
)

Checks if the point data array, associated with the provided name, has been cached for the AMR block with the given composite index.

◆ HasAMRBlock()

bool vtkAMRDataSetCache::HasAMRBlock ( const int  compositeIdx)

Checks if the AMR block associated with the given composite is cached.

Member Data Documentation

◆ Cache

AMRCacheType vtkAMRDataSetCache::Cache
protected

Definition at line 105 of file vtkAMRDataSetCache.h.


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