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 vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.

vtkTimerLog *	NewInstance () const

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

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

void	StopTimer ()
	Sets EndTime to the current time.

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

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

virtual void	DebugOn ()
	Turn debugging output on.

virtual void	DebugOff ()
	Turn debugging output off.

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

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

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

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

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

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

vtkTypeBool	HasObserver (unsigned long event)

vtkTypeBool	HasObserver (const char *event)

vtkTypeBool	InvokeEvent (unsigned long event)

vtkTypeBool	InvokeEvent (const char *event)

std::string	GetObjectDescription () const override
	The object description printed in messages and PrintSelf output.

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

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

vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObservers (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkTypeBool	HasObserver (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

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.

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events.

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.

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

vtkTypeBool	InvokeEvent (const char event, void callData)
	This method invokes an event and return whether the event was aborted or not.

virtual void	SetObjectName (const std::string &objectName)
	Set/get the name of this object for reporting purposes.

virtual std::string	GetObjectName () const
	Set/get the name of this object for reporting purposes.

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string.

virtual std::string	GetObjectDescription () const
	The object description printed in messages and PrintSelf output.

virtual vtkTypeBool	IsA (const char *name)
	Return 1 if this class is the same type of (or a subclass of) the named class.

virtual vtkIdType	GetNumberOfGenerationsFromBase (const char *name)
	Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).

virtual void	Delete ()
	Delete a VTK object.

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

void	InitializeObjectBase ()

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

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

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

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

void	SetReferenceCount (int)
	Sets the reference count.

bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space.

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

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

virtual bool	UsesGarbageCollector () const
	Indicate whether the class uses `vtkGarbageCollector` or not.

Static Public Member Functions
static vtkTimerLog *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkTimerLog *	SafeDownCast (vtkObjectBase *o)

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

static int	GetLogging ()

static void	LoggingOn ()

static void	LoggingOff ()

static void	FormatAndMarkEvent (const char *format,...) VTK_FORMAT_PRINTF(1
	Record a timing event.

static void	DumpLogWithIndents (ostream *os, double threshold)

static void	DumpLogWithIndentsAndPercentages (ostream *os)

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

static void	ResetLog ()
	Clear the timing table.

static void	CleanupLog ()
	Remove timer log.

static double	GetUniversalTime ()
	Returns the elapsed number of seconds since 00:00:00 Coordinated Universal Time (UTC), Thursday, 1 January 1970.

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


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

static int	GetMaxEntries ()
	Set/Get the maximum number of entries allowed in the timer log.


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


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.

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


static void	InsertTimedEvent (const char *EventString, double time, int cpuTicks)
	Insert an event with a known wall time value (in seconds) and cpuTicks.


static int	GetNumberOfEvents ()
	Programmatic access to events.

static int	GetEventIndent (int i)
	Programmatic access to events.

static double	GetEventWallTime (int i)
	Programmatic access to events.

static const char *	GetEventString (int i)
	Programmatic access to events.

static vtkTimerLogEntry::LogEntryType	GetEventType (int i)
	Programmatic access to events.

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.

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

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

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

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

static vtkTypeBool	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

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.

static vtkIdType	GetNumberOfGenerationsFromBaseType (const char *name)
	Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).

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

static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.

static bool	GetUsingMemkind ()
	A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkTimerLog ()

	~vtkTimerLog () override=default

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=nullptr)
	These methods allow a command to exclusively grab all events.

void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events.

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	RegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	ReportReferences (vtkGarbageCollector *)

virtual void	ObjectFinalize ()

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Static Protected Member Functions
static void	MarkEventInternal (const char EventString, vtkTimerLogEntry::LogEntryType type, vtkTimerLogEntry entry=nullptr)
	Record a timing event and capture wall time and cpu ticks.

static vtkTimerLogEntry *	GetEvent (int i)

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

Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

Protected Attributes
double	StartTime

double	EndTime

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

std::string	ObjectName

Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	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 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)

Online Examples:

KDTreeTimingDemo

ModifiedBSPTreeTimingDemo

OBBTreeTimingDemo

OctreeTimingDemo

CompareExtractSurface

SaveSceneToFile

TimerLog

CorrectlyRenderTranslucentGeometry

Tests:: vtkTimerLog (Tests)

Definition at line 173 of file vtkTimerLog.h.

Member Typedef Documentation

◆ Superclass

typedef vtkObject vtkTimerLog::Superclass

Definition at line 178 of file vtkTimerLog.h.

Constructor & Destructor Documentation

◆ vtkTimerLog()

vtkTimerLog::vtkTimerLog ( )

inlineprotected

Definition at line 291 of file vtkTimerLog.h.

◆ ~vtkTimerLog()

vtkTimerLog::~vtkTimerLog ( )

overrideprotecteddefault

Member Function Documentation

◆ New()

static vtkTimerLog * vtkTimerLog::New ( )

static

◆ IsTypeOf()

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

static

◆ IsA()

virtual vtkTypeBool 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 logging of events off or on.

By default, logging is on.

Definition at line 185 of file vtkTimerLog.h.

◆ GetLogging()

static int vtkTimerLog::GetLogging ( )

inlinestatic

Definition at line 186 of file vtkTimerLog.h.

◆ LoggingOn()

static void vtkTimerLog::LoggingOn ( )

inlinestatic

Definition at line 187 of file vtkTimerLog.h.

◆ LoggingOff()

static void vtkTimerLog::LoggingOff ( )

inlinestatic

Definition at line 188 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

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

◆ FormatAndMarkEvent()

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

static

Record a timing event.

The event is represented by a formatted string. The internal buffer is 4096 bytes and will truncate anything longer.

◆ DumpLog()

static void static void vtkTimerLog::DumpLog ( VTK_FILEPATH 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

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.

◆ InsertTimedEvent()

static void vtkTimerLog::InsertTimedEvent	(	const char *	EventString,
		double	time,
		int	cpuTicks
	)

static

Insert an event with a known wall time value (in seconds) and cpuTicks.

◆ DumpLogWithIndents()

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

static

◆ DumpLogWithIndentsAndPercentages()

static void vtkTimerLog::DumpLogWithIndentsAndPercentages ( ostream * os )

static