ParaView
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkPVCacheKeeper Class Reference

manages data cache for flip book animations. More...

#include <vtkPVCacheKeeper.h>

Inherits vtkDataObjectAlgorithm.

Collaboration diagram for vtkPVCacheKeeper:
Collaboration graph
[legend]

Public Types

typedef vtkDataObjectAlgorithm Superclass
 

Public Member Functions

virtual const char * GetClassName ()
 
virtual int IsA (const char *type)
 
void PrintSelf (ostream &os, vtkIndent indent)
 
void RemoveAllCaches ()
 Methods for saving, clearing and updating flip books. More...
 
bool IsCached (double cacheTime)
 Returns if the given cacheTime is available in the cache. More...
 
bool IsCached ()
 
virtual void SetCacheTime (double)
 Set/Get the current cache time. More...
 
virtual double GetCacheTime ()
 Set/Get the current cache time. More...
 
virtual void SetCachingEnabled (bool)
 Get/Set if caching is enabled. More...
 
virtual bool GetCachingEnabled ()
 Get/Set if caching is enabled. More...
 
virtual void CachingEnabledOn ()
 Get/Set if caching is enabled. More...
 
virtual void CachingEnabledOff ()
 Get/Set if caching is enabled. More...
 

Static Public Member Functions

static vtkPVCacheKeeperNew ()
 
static int IsTypeOf (const char *type)
 
static vtkPVCacheKeeperSafeDownCast (vtkObject *o)
 
static void ClearCacheStateFlags ()
 These methods are used for testing. More...
 
static int GetCacheHits ()
 These methods are used for testing. More...
 
static int GetCacheMisses ()
 These methods are used for testing. More...
 
static int GetCacheSkips ()
 These methods are used for testing. More...
 

Protected Member Functions

 vtkPVCacheKeeper ()
 
 ~vtkPVCacheKeeper ()
 
int RequestDataObject (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
 
int RequestData (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
 
virtual vtkExecutive * CreateDefaultExecutive ()
 
bool SaveData (vtkDataObject *)
 Called to save the data in cache. More...
 
void SetCacheSizeKeeper (vtkCacheSizeKeeper *)
 Get/Set the cache size keeper. More...
 
virtual vtkCacheSizeKeeperGetCacheSizeKeeper ()
 Get/Set the cache size keeper. More...
 

Protected Attributes

bool CachingEnabled
 
double CacheTime
 
vtkCacheSizeKeeperCacheSizeKeeper
 

Detailed Description

manages data cache for flip book animations.

vtkPVCacheKeeper manages data cache for flip book animations. When caching is disabled, this simply acts as a pass through filter. When caching is enabled, is the current time step has been previously cached then this filter shuts the update request, otherwise propagates the update and then cache the result for later use. The current time step is set using SetCacheTime().

See also
vtkPVCacheKeeperPipeline

Definition at line 37 of file vtkPVCacheKeeper.h.

Member Typedef Documentation

◆ Superclass

typedef vtkDataObjectAlgorithm vtkPVCacheKeeper::Superclass

Definition at line 41 of file vtkPVCacheKeeper.h.

Constructor & Destructor Documentation

◆ vtkPVCacheKeeper()

vtkPVCacheKeeper::vtkPVCacheKeeper ( )
protected

◆ ~vtkPVCacheKeeper()

vtkPVCacheKeeper::~vtkPVCacheKeeper ( )
protected

Member Function Documentation

◆ New()

static vtkPVCacheKeeper* vtkPVCacheKeeper::New ( )
static

◆ GetClassName()

virtual const char* vtkPVCacheKeeper::GetClassName ( )
virtual

◆ IsTypeOf()

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

◆ IsA()

virtual int vtkPVCacheKeeper::IsA ( const char *  type)
virtual

◆ SafeDownCast()

static vtkPVCacheKeeper* vtkPVCacheKeeper::SafeDownCast ( vtkObject *  o)
static

◆ PrintSelf()

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

◆ RemoveAllCaches()

void vtkPVCacheKeeper::RemoveAllCaches ( )

Methods for saving, clearing and updating flip books.

This removes all saved cache.

◆ SetCacheTime()

virtual void vtkPVCacheKeeper::SetCacheTime ( double  )
virtual

Set/Get the current cache time.

◆ GetCacheTime()

virtual double vtkPVCacheKeeper::GetCacheTime ( )
virtual

Set/Get the current cache time.

◆ IsCached() [1/2]

bool vtkPVCacheKeeper::IsCached ( double  cacheTime)

Returns if the given cacheTime is available in the cache.

Does not cause any updates.

◆ IsCached() [2/2]

bool vtkPVCacheKeeper::IsCached ( )
inline

Definition at line 63 of file vtkPVCacheKeeper.h.

◆ SetCachingEnabled()

virtual void vtkPVCacheKeeper::SetCachingEnabled ( bool  )
virtual

Get/Set if caching is enabled.

Default is true.

◆ GetCachingEnabled()

virtual bool vtkPVCacheKeeper::GetCachingEnabled ( )
virtual

Get/Set if caching is enabled.

Default is true.

◆ CachingEnabledOn()

virtual void vtkPVCacheKeeper::CachingEnabledOn ( )
virtual

Get/Set if caching is enabled.

Default is true.

◆ CachingEnabledOff()

virtual void vtkPVCacheKeeper::CachingEnabledOff ( )
virtual

Get/Set if caching is enabled.

Default is true.

◆ ClearCacheStateFlags()

static void vtkPVCacheKeeper::ClearCacheStateFlags ( )
static

These methods are used for testing.

Using this global state we can add checks to ensure that cache was used or not used for a particular sequence of actions.

◆ GetCacheHits()

static int vtkPVCacheKeeper::GetCacheHits ( )
static

These methods are used for testing.

Using this global state we can add checks to ensure that cache was used or not used for a particular sequence of actions.

◆ GetCacheMisses()

static int vtkPVCacheKeeper::GetCacheMisses ( )
static

These methods are used for testing.

Using this global state we can add checks to ensure that cache was used or not used for a particular sequence of actions.

◆ GetCacheSkips()

static int vtkPVCacheKeeper::GetCacheSkips ( )
static

These methods are used for testing.

Using this global state we can add checks to ensure that cache was used or not used for a particular sequence of actions.

◆ SetCacheSizeKeeper()

void vtkPVCacheKeeper::SetCacheSizeKeeper ( vtkCacheSizeKeeper )
protected

Get/Set the cache size keeper.

The cacher reports its cache size to this keeper, if any.

◆ GetCacheSizeKeeper()

virtual vtkCacheSizeKeeper* vtkPVCacheKeeper::GetCacheSizeKeeper ( )
protectedvirtual

Get/Set the cache size keeper.

The cacher reports its cache size to this keeper, if any.

◆ RequestDataObject()

int vtkPVCacheKeeper::RequestDataObject ( vtkInformation *  request,
vtkInformationVector **  inputVector,
vtkInformationVector *  outputVector 
)
protected

◆ RequestData()

int vtkPVCacheKeeper::RequestData ( vtkInformation *  request,
vtkInformationVector **  inputVector,
vtkInformationVector *  outputVector 
)
protected

◆ CreateDefaultExecutive()

virtual vtkExecutive* vtkPVCacheKeeper::CreateDefaultExecutive ( )
protectedvirtual

◆ SaveData()

bool vtkPVCacheKeeper::SaveData ( vtkDataObject *  )
protected

Called to save the data in cache.

Returns true if data is saved otherwise false.

Member Data Documentation

◆ CachingEnabled

bool vtkPVCacheKeeper::CachingEnabled
protected

Definition at line 111 of file vtkPVCacheKeeper.h.

◆ CacheTime

double vtkPVCacheKeeper::CacheTime
protected

Definition at line 112 of file vtkPVCacheKeeper.h.

◆ CacheSizeKeeper

vtkCacheSizeKeeper* vtkPVCacheKeeper::CacheSizeKeeper
protected

Definition at line 113 of file vtkPVCacheKeeper.h.


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