vtk
Class vtkTimerLog

java.lang.Object
  vtk.vtkObjectBase
      vtk.vtkObject
          vtk.vtkTimerLog

All Implemented Interfaces:

java.io.Serializable

public class vtkTimerLog

extends vtkObject

implements java.io.Serializable

vtkTimerLog - 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. JavaBean wrapper for vtkTimerLog object.

Author:

vtk2jbean Automatic JavaBean wrapper for VTK.

See Also:

Serialized Form

Field Summary

protected java.beans.PropertyChangeSupport

changes

Fields inherited from class vtk.vtkObjectBase

vtkId

Constructor Summary

	vtkTimerLog()
protected	vtkTimerLog(int dmy)

Method Summary

void	allocateLog() Allocate timing table with MaxEntries elements.
void	cleanupLog() Remove timer log.
void	dumpLog(java.lang.String id0) Write the timing table out to a file.
java.lang.String	getClassName() Return the class name as a string.
double	getCPUTime() Returns the CPU time for this process On Win32 platforms this actually returns wall time.
double	getCurrentTime() Returns the elapsed number of seconds since January 1, 1970.
double	getElapsedTime() Returns the difference between StartTime and EndTime as a doubleing point value indicating the elapsed time in seconds.
int	getEventIndent(int id0) Programatic access to events.
java.lang.String	getEventString(int id0) Programatic access to events.
double	getEventWallTime(int id0) Programatic access to events.
int	getLogging() This flag will turn loging of events off or on.
int	getMaxEntries() Set/Get the maximum number of entries allowed in the timer log
int	getNumberOfEvents() Programatic access to events.
vtkTimerLog	getThisTimerLog()
int	isA(java.lang.String id0) Return 1 if this class is the same type of (or a subclass of) the named class.
void	loggingOff() Set/Get the maximum number of entries allowed in the timer log
void	loggingOn() This flag will turn loging of events off or on.
void	markEndEvent(java.lang.String id0) I want to time events, so I am creating this interface to mark events that have a start and an end.
void	markEvent(java.lang.String id0) Record a timing event and capture wall time and cpu ticks.
void	markStartEvent(java.lang.String id0) I want to time events, so I am creating this interface to mark events that have a start and an end.
void	resetLog() Clear the timing table.
void	setLogging(int id0) This flag will turn loging of events off or on.
void	setMaxEntries(int id0) Set/Get the maximum number of entries allowed in the timer log
void	startTimer() Set the StartTime to the current time.
void	stopTimer() Sets EndTime to the current time.
protected void	VTKCastInit()
void	VTKInit()

Methods inherited from class vtk.vtkObject

AddObserver, breakOnError, debugOff, debugOn, getDebug, getGlobalWarningDisplay, getMTime, getThisObject, globalWarningDisplayOff, globalWarningDisplayOn, hasObserver, hasObserver, invokeEvent, invokeEvent, modified, Print, PrintRevisions, register, removeObserver, removeObservers, removeObservers, setDebug, setGlobalWarningDisplay, unRegister

Methods inherited from class vtk.vtkObjectBase

addPropertyChangeListener, finalize, getReferenceCount, getThisObjectBase, isTypeOf, removePropertyChangeListener, setReferenceCount, VTKDelete

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

changes

protected java.beans.PropertyChangeSupport changes

Constructor Detail

vtkTimerLog

public vtkTimerLog()

vtkTimerLog

protected vtkTimerLog(int dmy)

Method Detail

getThisTimerLog

public vtkTimerLog getThisTimerLog()

getClassName

public java.lang.String getClassName()

Description copied from class: vtkObjectBase

Return the class name as a string. This method is defined in all subclasses of vtkObjectBase with the vtkTypeRevisionMacro found in vtkSetGet.h.

Overrides:

getClassName in class vtkObject

isA

public int isA(java.lang.String id0)

Description copied from class: vtkObjectBase

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 vtkTypeRevisionMacro found in vtkSetGet.h.

Overrides:

isA in class vtkObject

setLogging

public void setLogging(int id0)

This flag will turn loging of events off or on. By default, logging is on.

getLogging

public int getLogging()

This flag will turn loging of events off or on. By default, logging is on.

loggingOn

public void loggingOn()

This flag will turn loging of events off or on. By default, logging is on.

loggingOff

public void loggingOff()

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

setMaxEntries

public void setMaxEntries(int id0)

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

getMaxEntries

public int getMaxEntries()

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

dumpLog

public void dumpLog(java.lang.String id0)

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

markStartEvent

public void markStartEvent(java.lang.String id0)

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

public void markEndEvent(java.lang.String id0)

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.

getNumberOfEvents

public int getNumberOfEvents()

Programatic access to events. Indexed from 0 to num-1.

getEventIndent

public int getEventIndent(int id0)

Programatic access to events. Indexed from 0 to num-1.

getEventWallTime

public double getEventWallTime(int id0)

Programatic access to events. Indexed from 0 to num-1.

getEventString

public java.lang.String getEventString(int id0)

Programatic access to events. Indexed from 0 to num-1.

markEvent

public void markEvent(java.lang.String id0)

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

resetLog

public void resetLog()

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

allocateLog

public void allocateLog()

Allocate timing table with MaxEntries elements.

cleanupLog

public void cleanupLog()

Remove timer log.

getCurrentTime

public double getCurrentTime()

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

getCPUTime

public double getCPUTime()

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

startTimer

public void startTimer()

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

stopTimer

public void stopTimer()

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

getElapsedTime

public double getElapsedTime()

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

VTKInit

public void VTKInit()

Overrides:

VTKInit in class vtkObject

VTKCastInit

protected void VTKCastInit()

Overrides:

VTKCastInit in class vtkObject