progress handler. More...

#include <vtkPVProgressHandler.h>

Inheritance diagram for vtkPVProgressHandler:

Collaboration diagram for vtkPVProgressHandler:

[legend]

Public Types
typedef vtkObject	Superclass

Public Member Functions
virtual const char *	GetClassName ()

virtual int	IsA (const char *type)

void	PrintSelf (ostream &os, vtkIndent indent) override

void	RegisterProgressEvent (vtkObject *object, int id)
	Listen to progress events from the object. More...

void	PrepareProgress ()
	This method resets all the progress counters and prepares progress reporting. More...

void	AddHandlers ()
	This method add wrong tag event handlers and rmi call back for progress related mathods. More...

bool	GetEnableProgress ()
	Get whether or not progress is currently enable and if this progress handler is ready to receive progress events. More...

void	CleanupPendingProgress ()
	This method collects all outstanding progress messages. More...

void	LocalCleanupPendingProgress ()
	Local cleanup of progress flags. More...


void	SetSession (vtkPVSession *conn)
	Get/Set the session. More...

virtual vtkPVSession *	GetSession ()
	Get/Set the session. More...


virtual void	SetProgressInterval (double)
	Get/Set the progress interval in seconds. More...

virtual double	GetProgressInterval ()
	Get/Set the progress interval in seconds. More...


virtual char *	GetLastProgressText ()
	These are only valid in handler for the vtkCommand::ProgressEvent. More...

virtual int	GetLastProgress ()
	These are only valid in handler for the vtkCommand::ProgressEvent. More...

Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)

virtual void	DebugOn ()

virtual void	DebugOff ()

bool	GetDebug ()

void	SetDebug (bool debugFlag)

virtual void	Modified ()

virtual vtkMTimeType	GetMTime ()

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

int	HasObserver (unsigned long event)

int	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)

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)

vtkCommand *	GetCommand (unsigned long tag)

void	RemoveObserver (vtkCommand *)

void	RemoveObservers (unsigned long event, vtkCommand *)

void	RemoveObservers (const char event, vtkCommand )

int	HasObserver (unsigned long event, vtkCommand *)

int	HasObserver (const char event, vtkCommand )

unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)

unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

int	InvokeEvent (unsigned long event, void *callData)

int	InvokeEvent (const char event, void callData)

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)

vtkCommand *	GetCommand (unsigned long tag)

void	RemoveObserver (vtkCommand *)

void	RemoveObservers (unsigned long event, vtkCommand *)

void	RemoveObservers (const char event, vtkCommand )

int	HasObserver (unsigned long event, vtkCommand *)

int	HasObserver (const char event, vtkCommand )

unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)

unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

int	InvokeEvent (unsigned long event, void *callData)

int	InvokeEvent (const char event, void callData)

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const

virtual void	Delete ()

virtual void	FastDelete ()

void	Print (ostream &os)

virtual void	Register (vtkObjectBase *o)

virtual void	UnRegister (vtkObjectBase *o)

void	SetReferenceCount (int)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

void	PrintRevisions (ostream &)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

void	PrintRevisions (ostream &)

Static Public Member Functions
static vtkPVProgressHandler *	New ()

static int	IsTypeOf (const char *type)

static vtkPVProgressHandler *	SafeDownCast (vtkObject *o)

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()

static void	BreakOnError ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)

static vtkObjectBase *	New ()

static vtkObjectBase *	New ()

Protected Types
enum	TAGS { CLEANUP_TAG = 188969, PROGRESS_EVENT_TAG = 188970, MESSAGE_EVENT_TAG = 188971 }

enum	RMI_TAGS { CLEANUP_TAG_RMI = 188972, MESSAGE_EVENT_TAG_RMI = 188973 }

Protected Member Functions
	vtkPVProgressHandler ()

	~vtkPVProgressHandler () override

void	RefreshProgress (const char *progress_text, double progress)
	Update the last progress and progress text and invokes a progress event. More...

Protected Member Functions inherited from vtkObject
	vtkObject ()

virtual	~vtkObject ()

void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) VTK_OVERRIDE

void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) VTK_OVERRIDE

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)

void	InternalReleaseFocus ()

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)

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
vtkPVSession *	Session

double	ProgressInterval

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Friends
class	RMICallback

Detailed Description

progress handler.

vtkPVProgressHandler handles the progress messages. It handles progress in all configurations single process, client-server. It must be noted that when running in parallel, progress updates are fetched from the root node. Due to performance reasons, we no longer collect progress events (or messages) from satellites, only root-node events are reported back to the client. While this may not faithfully report the progress, this avoid nasty MPI issues that can be painful to debug and diagnose.

Progress events are currently not supported in multi-clients mode.

Events:

vtkCommand::StartEvent

fired to indicate beginning of progress handling
calldata: vtkPVProgressHandler* vtkCommand::ProgressEvent
fired to indicate a progress event.
calldata: vtkPVProgressHandler* vtkCommand::EndEvent
fired to indicate end of progress handling
calldata: vtkPVProgressHandler*

Starting ParaView 5.5, vtkCommand::MessageEvent is no longer fired.

Definition at line 40 of file vtkPVProgressHandler.h.

Member Typedef Documentation

◆ Superclass

typedef vtkObject vtkPVProgressHandler::Superclass

Definition at line 44 of file vtkPVProgressHandler.h.

Member Enumeration Documentation

◆ TAGS

enum vtkPVProgressHandler::TAGS

protected

Enumerator
CLEANUP_TAG
PROGRESS_EVENT_TAG
MESSAGE_EVENT_TAG

Definition at line 111 of file vtkPVProgressHandler.h.

◆ RMI_TAGS

enum vtkPVProgressHandler::RMI_TAGS

protected

Enumerator
CLEANUP_TAG_RMI
MESSAGE_EVENT_TAG_RMI

Definition at line 118 of file vtkPVProgressHandler.h.

Constructor & Destructor Documentation

◆ vtkPVProgressHandler()

vtkPVProgressHandler::vtkPVProgressHandler ( )

protected

◆ ~vtkPVProgressHandler()

vtkPVProgressHandler::~vtkPVProgressHandler ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkPVProgressHandler* vtkPVProgressHandler::New ( )

static

◆ GetClassName()

virtual const char* vtkPVProgressHandler::GetClassName ( )

virtual

◆ IsTypeOf()

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

static

◆ IsA()

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

virtual

Reimplemented from vtkObjectBase.

◆ SafeDownCast()

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

static

◆ PrintSelf()

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

overridevirtual

Reimplemented from vtkObject.

◆ SetSession()

void vtkPVProgressHandler::SetSession ( vtkPVSession * conn )

Get/Set the session.

This is not reference-counted to avoid cycles.

◆ GetSession()

virtual vtkPVSession* vtkPVProgressHandler::GetSession ( )

virtual

Get/Set the session.

This is not reference-counted to avoid cycles.

◆ RegisterProgressEvent()

void vtkPVProgressHandler::RegisterProgressEvent	(	vtkObject *	object,
		int	id
	)

Listen to progress events from the object.

◆ PrepareProgress()

void vtkPVProgressHandler::PrepareProgress ( )

This method resets all the progress counters and prepares progress reporting.

All progress events before this call are ignored.

◆ AddHandlers()

void vtkPVProgressHandler::AddHandlers ( )

This method add wrong tag event handlers and rmi call back for progress related mathods.

◆ GetEnableProgress()

bool vtkPVProgressHandler::GetEnableProgress ( )

Get whether or not progress is currently enable and if this progress handler is ready to receive progress events.

◆ CleanupPendingProgress()

void vtkPVProgressHandler::CleanupPendingProgress ( )

This method collects all outstanding progress messages.

All progress events after this call are ignored.

◆ LocalCleanupPendingProgress()

void vtkPVProgressHandler::LocalCleanupPendingProgress ( )

Local cleanup of progress flags.

◆ SetProgressInterval()

virtual void vtkPVProgressHandler::SetProgressInterval ( double )

virtual

Get/Set the progress interval in seconds.

Progress events occurring more frequently than this interval are skipped. Default is 0.1 seconds on client and 1 second on server and batch processes.

◆ GetProgressInterval()

virtual double vtkPVProgressHandler::GetProgressInterval ( )

virtual

Get/Set the progress interval in seconds.

Progress events occurring more frequently than this interval are skipped. Default is 0.1 seconds on client and 1 second on server and batch processes.

◆ GetLastProgressText()

virtual char* vtkPVProgressHandler::GetLastProgressText ( )

virtual

These are only valid in handler for the vtkCommand::ProgressEvent.

◆ GetLastProgress()

virtual int vtkPVProgressHandler::GetLastProgress ( )

virtual

These are only valid in handler for the vtkCommand::ProgressEvent.

◆ RefreshProgress()

void vtkPVProgressHandler::RefreshProgress	(	const char *	progress_text,
		double	progress
	)

protected

Update the last progress and progress text and invokes a progress event.

Friends And Related Function Documentation

◆ RMICallback

friend class RMICallback

friend

Definition at line 166 of file vtkPVProgressHandler.h.

Member Data Documentation

◆ Session

vtkPVSession* vtkPVProgressHandler::Session

protected

Definition at line 129 of file vtkPVProgressHandler.h.

◆ ProgressInterval

double vtkPVProgressHandler::ProgressInterval

protected

Definition at line 130 of file vtkPVProgressHandler.h.

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

/builds/gitlab-kitware-sciviz-ci/Remoting/Core/vtkPVProgressHandler.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ Superclass

Member Enumeration Documentation

◆ TAGS

◆ RMI_TAGS

Constructor & Destructor Documentation

◆ vtkPVProgressHandler()

◆ ~vtkPVProgressHandler()

Member Function Documentation

◆ New()

◆ GetClassName()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ PrintSelf()

◆ SetSession()

◆ GetSession()

◆ RegisterProgressEvent()

◆ PrepareProgress()

◆ AddHandlers()

◆ GetEnableProgress()

◆ CleanupPendingProgress()

◆ LocalCleanupPendingProgress()

◆ SetProgressInterval()

◆ GetProgressInterval()

◆ GetLastProgressText()

◆ GetLastProgress()

◆ RefreshProgress()

Friends And Related Function Documentation

◆ RMICallback

Member Data Documentation

◆ Session

◆ ProgressInterval