vtkTimerLog Class Reference
#include <vtkTimerLog.h>
Inheritance diagram for vtkTimerLog:
[legend]Collaboration diagram for vtkTimerLog:
[legend]List of all members.
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.
- Created by:
-
- CVS contributions (if > 5%):
- Martin, Ken (54%)
- Law, Charles (19%)
- Miller, Jim (8%)
- CVS logs (CVSweb):
/Common/vtkTimerLog.h)/Common/vtkTimerLog.cxx)
- Examples:
- vtkTimerLog (Examples)
- Tests:
- vtkTimerLog (Tests)
Definition at line 98 of file vtkTimerLog.h.
Member Typedef Documentation
Constructor & Destructor Documentation
| vtkTimerLog::vtkTimerLog |
( |
|
) |
[inline, protected] |
|
| virtual vtkTimerLog::~vtkTimerLog |
( |
|
) |
[inline, protected, virtual] |
|
Member Function Documentation
|
|
Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
Reimplemented from vtkObject. |
| virtual const char* vtkTimerLog::GetClassName |
( |
|
) |
[virtual] |
|
| int vtkTimerLog::IsTypeOf |
( |
const char * |
type |
) |
[static] |
|
|
|
Return 1 if this class type 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.
Reimplemented from vtkObject. |
| virtual int vtkTimerLog::IsA |
( |
const char * |
type |
) |
[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 vtkTypeRevisionMacro found in vtkSetGet.h.
Reimplemented from vtkObject. |
| void vtkTimerLog::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. |
| void vtkTimerLog::SetLogging |
( |
int |
v |
) |
[inline, static] |
|
| int vtkTimerLog::GetLogging |
( |
|
) |
[inline, static] |
|
|
|
This flag will turn loging of events off or on. By default, logging is on.
Definition at line 110 of file vtkTimerLog.h. |
| void vtkTimerLog::LoggingOn |
( |
|
) |
[inline, static] |
|
|
|
This flag will turn loging of events off or on. By default, logging is on.
Definition at line 111 of file vtkTimerLog.h.
References SetLogging(). |
| void vtkTimerLog::LoggingOff |
( |
|
) |
[inline, static] |
|
|
|
This flag will turn loging of events off or on. By default, logging is on.
Definition at line 112 of file vtkTimerLog.h.
References SetLogging(). |
| void vtkTimerLog::SetMaxEntries |
( |
int |
a |
) |
[static] |
|
|
|
Set/Get the maximum number of entries allowed in the timer log |
| int vtkTimerLog::GetMaxEntries |
( |
|
) |
[static] |
|
|
|
Set/Get the maximum number of entries allowed in the timer log |
| void vtkTimerLog::FormatAndMarkEvent |
( |
const char * |
EventString, |
|
|
|
... |
|
) |
[static] |
|
|
|
Record a timing event. The event is represented by a formatted string. |
| 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. |
| 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. |
| 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. |
| void vtkTimerLog::DumpLogWithIndents |
( |
ostream * |
os, |
|
|
double |
threshold |
|
) |
[static] |
|
| int vtkTimerLog::GetNumberOfEvents |
( |
|
) |
[static] |
|
|
|
Programatic access to events. Indexed from 0 to num-1. |
| int vtkTimerLog::GetEventIndent |
( |
int |
i |
) |
[static] |
|
|
|
Programatic access to events. Indexed from 0 to num-1. |
| double vtkTimerLog::GetEventWallTime |
( |
int |
i |
) |
[static] |
|
|
|
Programatic access to events. Indexed from 0 to num-1. |
| const char* vtkTimerLog::GetEventString |
( |
int |
i |
) |
[static] |
|
|
|
Programatic access to events. Indexed from 0 to num-1. |
| void vtkTimerLog::MarkEvent |
( |
const char * |
EventString |
) |
[static] |
|
|
|
Record a timing event and capture wall time and cpu ticks. |
| void vtkTimerLog::ResetLog |
( |
|
) |
[static] |
|
|
|
Clear the timing table. walltime and cputime will also be set to zero when the first new event is recorded. |
| void vtkTimerLog::AllocateLog |
( |
|
) |
[static] |
|
|
|
Allocate timing table with MaxEntries elements. |
| void vtkTimerLog::CleanupLog |
( |
|
) |
[static] |
|
| double vtkTimerLog::GetCurrentTime |
( |
|
) |
[static] |
|
|
|
Returns the elapsed number of seconds since January 1, 1970. This is also called Universal Coordinated Time. |
| double vtkTimerLog::GetCPUTime |
( |
|
) |
[static] |
|
|
|
Returns the CPU time for this process On Win32 platforms this actually returns wall time. |
| void vtkTimerLog::StartTimer |
( |
|
) |
|
|
| void vtkTimerLog::StopTimer |
( |
|
) |
|
|
| double vtkTimerLog::GetElapsedTime |
( |
|
) |
|
|
|
|
Returns the difference between StartTime and EndTime as a doubleing point value indicating the elapsed time in seconds. |
| void vtkTimerLog::DumpEntry |
( |
ostream & |
os, |
|
|
int |
index, |
|
|
double |
time, |
|
|
double |
deltatime, |
|
|
int |
tick, |
|
|
int |
deltatick, |
|
|
const char * |
event |
|
) |
[static, protected] |
|
Member Data Documentation
The documentation for this class was generated from the following file: