Documentation for vtkTimerLog

vtkTimerLog - Timer support and logging

Description:

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.

Methods:

	void PrintSelf (unknown & ,vtkIndent )
	static vtkTimerLog *New ()
	const char *GetClassName ()
	static void SetMaxEntries (int )
	static int GetMaxEntries ()
	static void DumpLog (char *)
	static void MarkEvent (char *)
	static void ResetLog ()
	static void AllocateLog ()
	static double GetCurrentTime ()
	static double GetCPUTime ()
	void StartTimer ()
	void StopTimer ()
	double GetElapsedTime ()

Detailed Method Descriptions:

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

	static void SetMaxEntries (int )
	static int GetMaxEntries ()

Write the timing table out to a file. Calculate some helpful statistics (deltas and percentages) in the process.

static void DumpLog (char *)

Record a timing event and capture walltime and cputicks.

static void MarkEvent (char *)

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

static void ResetLog ()

Allocate timing table with MaxEntries elements.

static void AllocateLog ()

Returns the elapsed number of seconds since January 1, 1970. This is also called Universal Coordinated Time.

static double GetCurrentTime ()

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

static double GetCPUTime ()

Set the StartTime to the current time. Used with GetElapsedTime().

void StartTimer ()

Sets EndTime to the current time. Used with GetElapsedTime().

void StopTimer ()

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

double GetElapsedTime ()