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

prevents propagation of update More...

#include <vtkPVUpdateSuppressor.h>

Inherits vtkDataObjectAlgorithm.

Public Types

typedef vtkDataObjectAlgorithm Superclass
 

Public Member Functions

virtual const char * GetClassName ()
 
virtual int IsA (const char *type)
 
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual void ForceUpdate ()
 Force update on the input. More...
 
void SetEnabled (bool)
 Get/Set if the update suppressor is enabled. More...
 
virtual bool GetEnabled ()
 Get/Set if the update suppressor is enabled. More...
 
virtual vtkTimeStamp GetForcedUpdateTimeStamp ()
 Provides access to the timestamp when the most recent ForceUpdate() was called. More...
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static vtkPVUpdateSuppressorSafeDownCast (vtkObject *o)
 
static vtkPVUpdateSuppressorNew ()
 Construct with user-specified implicit function. More...
 

Protected Member Functions

 vtkPVUpdateSuppressor ()
 
 ~vtkPVUpdateSuppressor ()
 
int RequestDataObject (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
 
int RequestData (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
 
virtual vtkExecutive * CreateDefaultExecutive ()
 

Protected Attributes

vtkTimeStamp ForcedUpdateTimeStamp
 
bool Enabled
 

Detailed Description

prevents propagation of update

vtkPVUpdateSuppressor is simple filter that work with vtkUpdateSuppressorPipeline to block pipeline updates. One should call ForceUpdate() to update the input, if needed, explicitly. Note that ForceUpdate() may not result in input updating at all if it has been already updated by some other means.

Definition at line 32 of file vtkPVUpdateSuppressor.h.

Member Typedef Documentation

◆ Superclass

typedef vtkDataObjectAlgorithm vtkPVUpdateSuppressor::Superclass

Definition at line 35 of file vtkPVUpdateSuppressor.h.

Constructor & Destructor Documentation

◆ vtkPVUpdateSuppressor()

vtkPVUpdateSuppressor::vtkPVUpdateSuppressor ( )
protected

◆ ~vtkPVUpdateSuppressor()

vtkPVUpdateSuppressor::~vtkPVUpdateSuppressor ( )
protected

Member Function Documentation

◆ GetClassName()

virtual const char* vtkPVUpdateSuppressor::GetClassName ( )
virtual

◆ IsTypeOf()

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

◆ IsA()

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

◆ SafeDownCast()

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

◆ PrintSelf()

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

◆ New()

static vtkPVUpdateSuppressor* vtkPVUpdateSuppressor::New ( )
static

Construct with user-specified implicit function.

◆ ForceUpdate()

virtual void vtkPVUpdateSuppressor::ForceUpdate ( )
virtual

Force update on the input.

◆ SetEnabled()

void vtkPVUpdateSuppressor::SetEnabled ( bool  )

Get/Set if the update suppressor is enabled.

If the update suppressor is not enabled, it won't supress any updates. Enabled by default.

◆ GetEnabled()

virtual bool vtkPVUpdateSuppressor::GetEnabled ( )
virtual

Get/Set if the update suppressor is enabled.

If the update suppressor is not enabled, it won't supress any updates. Enabled by default.

◆ GetForcedUpdateTimeStamp()

virtual vtkTimeStamp vtkPVUpdateSuppressor::GetForcedUpdateTimeStamp ( )
virtual

Provides access to the timestamp when the most recent ForceUpdate() was called.

◆ RequestDataObject()

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

◆ RequestData()

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

◆ CreateDefaultExecutive()

virtual vtkExecutive* vtkPVUpdateSuppressor::CreateDefaultExecutive ( )
protectedvirtual

Member Data Documentation

◆ ForcedUpdateTimeStamp

vtkTimeStamp vtkPVUpdateSuppressor::ForcedUpdateTimeStamp
protected

Definition at line 74 of file vtkPVUpdateSuppressor.h.

◆ Enabled

bool vtkPVUpdateSuppressor::Enabled
protected

Definition at line 76 of file vtkPVUpdateSuppressor.h.


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