vtkSMPProgressObserver Class Reference

Progress observer that is thread safe. More...

#include <vtkSMPProgressObserver.h>

Inheritance diagram for vtkSMPProgressObserver:

Collaboration diagram for vtkSMPProgressObserver:

Public Types
typedef vtkProgressObserver	Superclass
Public Types inherited from vtkProgressObserver
typedef vtkObject	Superclass
Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass

Public Member Functions
virtual int	IsA (const char *type)
vtkSMPProgressObserver *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent)
void	UpdateProgress (double amount)
vtkProgressObserver *	GetLocalObserver ()
Public Member Functions inherited from vtkProgressObserver
vtkProgressObserver *	NewInstance () const
virtual double	GetProgress ()
Public Member Functions inherited from vtkObject
vtkObject *	NewInstance () const
virtual void	DebugOn ()
virtual void	DebugOff ()
bool	GetDebug ()
void	SetDebug (bool debugFlag)
virtual void	Modified ()
virtual unsigned long	GetMTime ()
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 *)
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)
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
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)
int	InvokeEvent (unsigned long event, void *callData)
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
virtual void	Delete ()
virtual void	FastDelete ()
void	Print (ostream &os)
virtual void	Register (vtkObjectBase *o)
virtual void	UnRegister (vtkObjectBase *o)
void	SetReferenceCount (int)
void	PrintRevisions (ostream &)
virtual void	PrintHeader (ostream &os, vtkIndent indent)
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
int	GetReferenceCount ()

Static Public Member Functions
static vtkSMPProgressObserver *	New ()
static int	IsTypeOf (const char *type)
static vtkSMPProgressObserver *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkProgressObserver
static vtkProgressObserver *	New ()
static int	IsTypeOf (const char *type)
static vtkProgressObserver *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkObject
static int	IsTypeOf (const char *type)
static vtkObject *	SafeDownCast (vtkObjectBase *o)
static vtkObject *	New ()
static void	BreakOnError ()
static void	SetGlobalWarningDisplay (int val)
static void	GlobalWarningDisplayOn ()
static void	GlobalWarningDisplayOff ()
static int	GetGlobalWarningDisplay ()
Static Public Member Functions inherited from vtkObjectBase
static int	IsTypeOf (const char *name)
static vtkObjectBase *	New ()

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkSMPProgressObserver ()
	~vtkSMPProgressObserver ()
Protected Member Functions inherited from vtkProgressObserver
	vtkProgressObserver ()
	~vtkProgressObserver ()
Protected Member Functions inherited from vtkObject
	vtkObject ()
virtual	~vtkObject ()
virtual void	RegisterInternal (vtkObjectBase *, int check)
virtual void	UnRegisterInternal (vtkObjectBase *, int check)
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
vtkSMPThreadLocalObject< vtkProgressObserver >	Observers
Protected Attributes inherited from vtkProgressObserver
double	Progress
Protected Attributes inherited from vtkObject
bool	Debug
vtkTimeStamp	MTime
vtkSubjectHelper *	SubjectHelper
Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount
vtkWeakPointerBase **	WeakPointers

Detailed Description

Progress observer that is thread safe.

vtkSMPProgressObserver is designed to handle progress events coming from an algorithm in a thread safe way. It does this by using thread local objects that it updates. To receive the progress information, one has to listen to the local observer in the same thread. Since the execution will be somewhat load balanced, it may be enough to do this only on the main thread.

Definition at line 33 of file vtkSMPProgressObserver.h.

Member Typedef Documentation

typedef vtkProgressObserver vtkSMPProgressObserver::Superclass

Definition at line 37 of file vtkSMPProgressObserver.h.

Constructor & Destructor Documentation

vtkSMPProgressObserver::vtkSMPProgressObserver ( )

protected

vtkSMPProgressObserver::~vtkSMPProgressObserver ( )

protected

Member Function Documentation

static vtkSMPProgressObserver* vtkSMPProgressObserver::New ( )

static

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

static

virtual int vtkSMPProgressObserver::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 vtkProgressObserver.

static vtkSMPProgressObserver* vtkSMPProgressObserver::SafeDownCast ( vtkObjectBase *  o )

static

virtual vtkObjectBase* vtkSMPProgressObserver::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkProgressObserver.

vtkSMPProgressObserver* vtkSMPProgressObserver::NewInstance

(

)

const

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

virtual

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 vtkProgressObserver.

void vtkSMPProgressObserver::UpdateProgress ( double  amount )

virtual

Passes the progress event to a thread local ProgressObserver instance.

Reimplemented from vtkProgressObserver.

vtkProgressObserver* vtkSMPProgressObserver::GetLocalObserver ( )

inline

Returns the progress observer local to the thread it was called from.

Definition at line 46 of file vtkSMPProgressObserver.h.

Member Data Documentation

vtkSMPThreadLocalObject<vtkProgressObserver> vtkSMPProgressObserver::Observers

protected

Definition at line 56 of file vtkSMPProgressObserver.h.

---

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

• /home/boeckb/code/depot/group-kitware/vtk/build-release/Utilities/Doxygen/dox/Common/ExecutionModel/vtkSMPProgressObserver.h