Timer support and logging. More...

#include <vtkTimerLog.h>

Inheritance diagram for vtkTimerLog:

Collaboration diagram for vtkTimerLog:

Public Types
typedef vtkObject	Superclass

Public Member Functions
virtual int	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class. More...

vtkTimerLog *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses. More...

void	StartTimer ()
	Set the StartTime to the current time. More...

void	StopTimer ()
	Sets EndTime to the current time. More...

double	GetElapsedTime ()
	Returns the difference between StartTime and EndTime as a doubleing point value indicating the elapsed time in seconds. More...

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

virtual void	DebugOn ()
	Turn debugging output on. More...

virtual void	DebugOff ()
	Turn debugging output off. More...

bool	GetDebug ()
	Get the value of the debug flag. More...

void	SetDebug (bool debugFlag)
	Set the value of the debug flag. More...

virtual void	Modified ()
	Update the modification time for this object. More...

virtual vtkMTimeType	GetMTime ()
	Return this object's modified time. More...

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

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)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...

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)
	Allow user to set the AbortFlagOn() with the return value of the callback method. More...

int	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not. More...

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
	Return the class name as a string. More...

virtual void	Delete ()
	Delete a VTK object. More...

virtual void	FastDelete ()
	Delete a reference to this object. More...

void	InitializeObjectBase ()

void	Print (ostream &os)
	Print an object to an ostream. More...

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

virtual void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object). More...

virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object). More...

int	GetReferenceCount ()
	Return the current reference count of this object. More...

void	SetReferenceCount (int)
	Sets the reference count. More...

void	PrintRevisions (ostream &)
	Legacy. More...

Static Public Member Functions
static vtkTimerLog *	New ()

static int	IsTypeOf (const char *type)

static vtkTimerLog *	SafeDownCast (vtkObjectBase *o)

static void	SetLogging (int v)
	This flag will turn loging of events off or on. More...

static int	GetLogging ()

static void	LoggingOn ()

static void	LoggingOff ()

static void	SetMaxEntries (int a)
	Set/Get the maximum number of entries allowed in the timer log. More...

static int	GetMaxEntries ()

static void	FormatAndMarkEvent (const char *EventString,...)
	Record a timing event. More...

static void	DumpLog (const char *filename)
	Write the timing table out to a file. More...

static void	MarkStartEvent (const char *EventString)
	I want to time events, so I am creating this interface to mark events that have a start and an end. More...

static void	MarkEndEvent (const char *EventString)

static void	DumpLogWithIndents (ostream *os, double threshold)

static void	DumpLogWithIndentsAndPercentages (ostream *os)

static int	GetNumberOfEvents ()
	Programatic access to events. More...

static int	GetEventIndent (int i)

static double	GetEventWallTime (int i)

static const char *	GetEventString (int i)

static void	MarkEvent (const char *EventString)
	Record a timing event and capture wall time and cpu ticks. More...

static void	ResetLog ()
	Clear the timing table. More...

static void	AllocateLog ()
	Allocate timing table with MaxEntries elements. More...

static void	CleanupLog ()
	Remove timer log. More...

static double	GetUniversalTime ()
	Returns the elapsed number of seconds since January 1, 1970. More...

static double	GetCPUTime ()
	Returns the CPU time for this process On Win32 platforms this actually returns wall time. More...

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

static void	BreakOnError ()
	This method is called when vtkErrorMacro executes. More...

static void	SetGlobalWarningDisplay (int val)
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)
	Return 1 if this class type is the same type of (or a subclass of) the named class. More...

static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkTimerLog ()

	~vtkTimerLog () override

Protected Member Functions inherited from vtkObject
	vtkObject ()

	~vtkObject () override

void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)
	These methods allow a command to exclusively grab all events. More...

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 vtkTimerLogEntry *	GetEvent (int i)

static void	DumpEntry (ostream &os, int index, double time, double deltatime, int tick, int deltatick, const char *event)

Protected Attributes
double	StartTime

double	EndTime

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Static Protected Attributes
static int	Logging

static int	Indent

static int	MaxEntries

static int	NextEntry

static int	WrapFlag

static int	TicksPerSecond

static vtkTimerLogEntry *	TimerLog

static timeval	FirstWallTime

static timeval	CurrentWallTime

static tms	FirstCpuTicks

static tms	CurrentCpuTicks

Detailed Description

Timer support and logging.

vtkTimerLog contains walltime and cputime measurements associated with a given event. These results can be later analyzed when "dumping out" the table.

In addition, vtkTimerLog allows the user to simply get the current time, and to start/stop a simple timer separate from the timing table logging.

Examples:: vtkTimerLog (Examples)

Tests:: vtkTimerLog (Tests)

Definition at line 80 of file vtkTimerLog.h.

Member Typedef Documentation

◆ Superclass

typedef vtkObject vtkTimerLog::Superclass

Definition at line 85 of file vtkTimerLog.h.

Constructor & Destructor Documentation

◆ vtkTimerLog()

vtkTimerLog::vtkTimerLog ( )

inlineprotected

Definition at line 190 of file vtkTimerLog.h.

◆ ~vtkTimerLog()

vtkTimerLog::~vtkTimerLog ( )

inlineoverrideprotected

Definition at line 191 of file vtkTimerLog.h.

Member Function Documentation

◆ New()

static vtkTimerLog* vtkTimerLog::New ( )

static

◆ IsTypeOf()

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

static

◆ IsA()

virtual int vtkTimerLog::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 vtkObjectBase.

◆ SafeDownCast()

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

static

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkTimerLog::NewInstanceInternal ( ) const

protectedvirtual

◆ NewInstance()

vtkTimerLog* vtkTimerLog::NewInstance ( ) const

◆ PrintSelf()

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

overridevirtual

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.

◆ SetLogging()

static void vtkTimerLog::SetLogging ( int v )

inlinestatic

This flag will turn loging of events off or on.

By default, logging is on.

Definition at line 92 of file vtkTimerLog.h.

◆ GetLogging()

static int vtkTimerLog::GetLogging ( )

inlinestatic

Definition at line 93 of file vtkTimerLog.h.

◆ LoggingOn()

static void vtkTimerLog::LoggingOn ( )

inlinestatic

Definition at line 94 of file vtkTimerLog.h.

◆ LoggingOff()

static void vtkTimerLog::LoggingOff ( )

inlinestatic

Definition at line 95 of file vtkTimerLog.h.

◆ SetMaxEntries()

static void vtkTimerLog::SetMaxEntries ( int a )

static

Set/Get the maximum number of entries allowed in the timer log.

◆ GetMaxEntries()

static int vtkTimerLog::GetMaxEntries ( )

static

◆ FormatAndMarkEvent()

static void vtkTimerLog::FormatAndMarkEvent	(	const char *	EventString,
			...
	)

static

Record a timing event.

The event is represented by a formatted string.

◆ DumpLog()

static void vtkTimerLog::DumpLog ( const char * filename )

static

Write the timing table out to a file.

Calculate some helpful statistics (deltas and percentages) in the process.

◆ MarkStartEvent()

static void vtkTimerLog::MarkStartEvent ( const char * EventString )

static

I want to time events, so I am creating this interface to mark events that have a start and an end.

These events can be, nested. The standard Dumplog ignores the indents.

◆ MarkEndEvent()

static void vtkTimerLog::MarkEndEvent ( const char * EventString )

static

◆ DumpLogWithIndents()

static void vtkTimerLog::DumpLogWithIndents	(	ostream *	os,
		double	threshold
	)

static

◆ DumpLogWithIndentsAndPercentages()

static void vtkTimerLog::DumpLogWithIndentsAndPercentages ( ostream * os )

static

◆ GetNumberOfEvents()

static int vtkTimerLog::GetNumberOfEvents ( )

static

Programatic access to events.

Indexed from 0 to num-1.

◆ GetEventIndent()

static int vtkTimerLog::GetEventIndent ( int i )

static

◆ GetEventWallTime()

static double vtkTimerLog::GetEventWallTime ( int i )

static

◆ GetEventString()

static const char* vtkTimerLog::GetEventString ( int i )

static

◆ MarkEvent()

static void vtkTimerLog::MarkEvent ( const char * EventString )

static

Record a timing event and capture wall time and cpu ticks.

◆ ResetLog()

static void vtkTimerLog::ResetLog ( )

static

Clear the timing table.

walltime and cputime will also be set to zero when the first new event is recorded.

◆ AllocateLog()

static void vtkTimerLog::AllocateLog ( )

static

Allocate timing table with MaxEntries elements.

◆ CleanupLog()

static void vtkTimerLog::CleanupLog ( )

static

Remove timer log.

◆ GetUniversalTime()

static double vtkTimerLog::GetUniversalTime ( )

static

Returns the elapsed number of seconds since January 1, 1970.

This is also called Universal Coordinated Time.

◆ GetCPUTime()

static double vtkTimerLog::GetCPUTime ( )

static

Returns the CPU time for this process On Win32 platforms this actually returns wall time.

◆ StartTimer()

void vtkTimerLog::StartTimer ( )

Set the StartTime to the current time.

Used with GetElapsedTime().

◆ StopTimer()

void vtkTimerLog::StopTimer ( )

Sets EndTime to the current time.

Used with GetElapsedTime().

◆ GetElapsedTime()

double vtkTimerLog::GetElapsedTime ( )

Returns the difference between StartTime and EndTime as a doubleing point value indicating the elapsed time in seconds.

◆ GetEvent()

static vtkTimerLogEntry* vtkTimerLog::GetEvent ( int i )

staticprotected

◆ DumpEntry()

static void vtkTimerLog::DumpEntry	(	ostream &	os,
		int	index,
		double	time,
		double	deltatime,
		int	tick,
		int	deltatick,
		const char *	event
	)

staticprotected

Member Data Documentation

◆ Logging

int vtkTimerLog::Logging

staticprotected

Definition at line 195 of file vtkTimerLog.h.

◆ Indent

int vtkTimerLog::Indent

staticprotected

Definition at line 196 of file vtkTimerLog.h.

◆ MaxEntries

int vtkTimerLog::MaxEntries

staticprotected

Definition at line 197 of file vtkTimerLog.h.

◆ NextEntry

int vtkTimerLog::NextEntry

staticprotected

Definition at line 198 of file vtkTimerLog.h.

◆ WrapFlag

int vtkTimerLog::WrapFlag

staticprotected

Definition at line 199 of file vtkTimerLog.h.

◆ TicksPerSecond

int vtkTimerLog::TicksPerSecond

staticprotected

Definition at line 200 of file vtkTimerLog.h.

◆ TimerLog

vtkTimerLogEntry* vtkTimerLog::TimerLog

staticprotected

Definition at line 201 of file vtkTimerLog.h.

◆ FirstWallTime

timeval vtkTimerLog::FirstWallTime

staticprotected

Definition at line 212 of file vtkTimerLog.h.

◆ CurrentWallTime

timeval vtkTimerLog::CurrentWallTime

staticprotected

Definition at line 213 of file vtkTimerLog.h.

◆ FirstCpuTicks

tms vtkTimerLog::FirstCpuTicks

staticprotected

Definition at line 214 of file vtkTimerLog.h.

◆ CurrentCpuTicks

tms vtkTimerLog::CurrentCpuTicks

staticprotected

Definition at line 215 of file vtkTimerLog.h.

◆ StartTime

double vtkTimerLog::StartTime

protected

Definition at line 220 of file vtkTimerLog.h.

◆ EndTime

double vtkTimerLog::EndTime

protected

Definition at line 221 of file vtkTimerLog.h.

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

dox/Common/System/vtkTimerLog.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkTimerLog()

◆ ~vtkTimerLog()

Member Function Documentation

◆ New()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ SetLogging()

◆ GetLogging()

◆ LoggingOn()

◆ LoggingOff()

◆ SetMaxEntries()

◆ GetMaxEntries()

◆ FormatAndMarkEvent()

◆ DumpLog()

◆ MarkStartEvent()

◆ MarkEndEvent()

◆ DumpLogWithIndents()

◆ DumpLogWithIndentsAndPercentages()

◆ GetNumberOfEvents()

◆ GetEventIndent()

◆ GetEventWallTime()

◆ GetEventString()

◆ MarkEvent()

◆ ResetLog()

◆ AllocateLog()

◆ CleanupLog()

◆ GetUniversalTime()

◆ GetCPUTime()

◆ StartTimer()

◆ StopTimer()

◆ GetElapsedTime()

◆ GetEvent()

◆ DumpEntry()

Member Data Documentation

◆ Logging

◆ Indent

◆ MaxEntries

◆ NextEntry

◆ WrapFlag

◆ TicksPerSecond

◆ TimerLog

◆ FirstWallTime

◆ CurrentWallTime

◆ FirstCpuTicks

◆ CurrentCpuTicks

◆ StartTime

◆ EndTime