Time filter execution. More...

#include <vtkExecutionTimer.h>

Inheritance diagram for vtkExecutionTimer:

Collaboration diagram for vtkExecutionTimer:

Public Types
typedef vtkObject	Superclass

Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass

Public Member Functions
virtual int	IsA (const char *type)

vtkExecutionTimer *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent)


void	SetFilter (vtkAlgorithm *filter)

virtual vtkAlgorithm *	GetFilter ()


virtual double	GetElapsedCPUTime ()


virtual double	GetElapsedWallClockTime ()

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 int	IsTypeOf (const char *type)

static vtkExecutionTimer *	SafeDownCast (vtkObjectBase *o)

static vtkExecutionTimer *	New ()

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

	vtkExecutionTimer ()

	~vtkExecutionTimer ()

virtual void	TimerFinished ()


void	StartTimer ()

void	StopTimer ()

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

Static Protected Member Functions
static void	EventRelay (vtkObject caller, unsigned long eventId, void clientData, void *callData)

Protected Attributes
vtkCallbackCommand *	Callback

vtkAlgorithm *	Filter

double	CPUStartTime

double	CPUEndTime

double	WallClockStartTime

double	WallClockEndTime

double	ElapsedCPUTime

double	ElapsedWallClockTime

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Detailed Description

Time filter execution.

This object monitors a single filter for StartEvent and EndEvent. Each time it hears StartEvent it records the time. Each time it hears EndEvent it measures the elapsed time (both CPU and wall-clock) since the most recent StartEvent. Internally we use vtkTimerLog for measurements.

By default we simply store the elapsed time. You are welcome to subclass and override TimerFinished() to do anything you want.

Tests:: vtkExecutionTimer (Tests)

Definition at line 43 of file vtkExecutionTimer.h.

Member Typedef Documentation

typedef vtkObject vtkExecutionTimer::Superclass

Definition at line 46 of file vtkExecutionTimer.h.

Constructor & Destructor Documentation

vtkExecutionTimer::vtkExecutionTimer ( )

protected

vtkExecutionTimer::~vtkExecutionTimer ( )

protected

Member Function Documentation

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

static

virtual int vtkExecutionTimer::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 vtkObject.

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

static

virtual vtkObjectBase* vtkExecutionTimer::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkObject.

vtkExecutionTimer* vtkExecutionTimer::NewInstance ( ) const

void vtkExecutionTimer::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 vtkObject.

static vtkExecutionTimer* vtkExecutionTimer::New ( )

static

Construct a new timer with no attached filter. Use SetFilter() to specify the vtkAlgorithm whose execution you want to time.

void vtkExecutionTimer::SetFilter ( vtkAlgorithm * filter )

Set/get the filter to be monitored. The only real constraint here is that the vtkExecutive associated with the filter must fire StartEvent and EndEvent before and after the filter is executed. All VTK executives should do this.

virtual vtkAlgorithm* vtkExecutionTimer::GetFilter ( )

virtual

Set/get the filter to be monitored. The only real constraint here is that the vtkExecutive associated with the filter must fire StartEvent and EndEvent before and after the filter is executed. All VTK executives should do this.

virtual double vtkExecutionTimer::GetElapsedCPUTime ( )

virtual

Get the total CPU time (in seconds) that elapsed between StartEvent and EndEvent. This is undefined before the filter has finished executing.

virtual double vtkExecutionTimer::GetElapsedWallClockTime ( )

virtual

Get the total wall clock time (in seconds) that elapsed between StartEvent and EndEvent. This is undefined before the filter has finished executing.

void vtkExecutionTimer::StartTimer ( )

protected

Convenience functions – StartTimer clears out the elapsed times and records start times; StopTimer records end times and computes the elapsed time

void vtkExecutionTimer::StopTimer ( )

protected

Convenience functions – StartTimer clears out the elapsed times and records start times; StopTimer records end times and computes the elapsed time

virtual void vtkExecutionTimer::TimerFinished ( )

protectedvirtual

This is where you can do anything you want with the progress event. By default this does nothing.

static void vtkExecutionTimer::EventRelay	(	vtkObject *	caller,
		unsigned long	eventId,
		void *	clientData,
		void *	callData
	)

staticprotected

This is the callback that VTK will invoke when it sees StartEvent and EndEvent. Its responsibility is to pass the event on to an instance of this observer class.

Member Data Documentation

vtkCallbackCommand* vtkExecutionTimer::Callback

protected

Definition at line 82 of file vtkExecutionTimer.h.

vtkAlgorithm* vtkExecutionTimer::Filter

protected

Definition at line 85 of file vtkExecutionTimer.h.

double vtkExecutionTimer::CPUStartTime

protected

Definition at line 88 of file vtkExecutionTimer.h.

double vtkExecutionTimer::CPUEndTime

protected

Definition at line 89 of file vtkExecutionTimer.h.

double vtkExecutionTimer::WallClockStartTime

protected

Definition at line 91 of file vtkExecutionTimer.h.

double vtkExecutionTimer::WallClockEndTime

protected

Definition at line 92 of file vtkExecutionTimer.h.

double vtkExecutionTimer::ElapsedCPUTime

protected

Definition at line 94 of file vtkExecutionTimer.h.

double vtkExecutionTimer::ElapsedWallClockTime

protected

Definition at line 95 of file vtkExecutionTimer.h.

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

/home/boeckb/code/depot/group-kitware/vtk/build-release/Utilities/Doxygen/dox/Filters/Core/vtkExecutionTimer.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation