VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes | Static Protected Attributes | List of all members
vtkTimerLog Class Reference

Timer support and logging. More...

#include <vtkTimerLog.h>

Inheritance diagram for vtkTimerLog:
[legend]
Collaboration diagram for vtkTimerLog:
[legend]

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...
 
vtkTimerLogNewInstance () 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...
 
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)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
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)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkCommandGetCommand (unsigned long tag)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObserver (vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
int HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
int HasObserver (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
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)
 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, 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)
 This method invokes an event and return whether the event was aborted or not. More...
 
- 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 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...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 

Static Public Member Functions

static vtkTimerLogNew ()
 
static int IsTypeOf (const char *type)
 
static vtkTimerLogSafeDownCast (vtkObjectBase *o)
 
static void SetLogging (int v)
 This flag will turn logging of events off or on. More...
 
static int GetLogging ()
 
static void LoggingOn ()
 
static void LoggingOff ()
 
static void FormatAndMarkEvent (const char *EventString,...)
 Record a timing event. More...
 
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. More...
 
static void ResetLog ()
 Clear the timing table. 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 void SetMaxEntries (int a)
 Set/Get the maximum number of entries allowed in the timer log. More...
 
static int GetMaxEntries ()
 Set/Get the maximum number of entries allowed in the timer log. 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)
 I want to time events, so I am creating this interface to mark events that have a start and an end. More...
 
static void InsertTimedEvent (const char *EventString, double time, int cpuTicks)
 Insert an event with a known wall time value (in seconds) and cpuTicks. More...
 
static int GetNumberOfEvents ()
 Programatic access to events. More...
 
static int GetEventIndent (int i)
 Programatic access to events. More...
 
static double GetEventWallTime (int i)
 Programatic access to events. More...
 
static const char * GetEventString (int i)
 Programatic access to events. More...
 
static vtkTimerLogEntry::LogEntryType GetEventType (int i)
 Programatic access to events. More...
 
static void AllocateLog ()
 Allocate timing table with MaxEntries elements. More...
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 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 ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOff ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static int GetGlobalWarningDisplay ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
- 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 vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () 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 ()
 These methods allow a command to exclusively grab all events. More...
 
- 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 void MarkEventInternal (const char *EventString, vtkTimerLogEntry::LogEntryType type, vtkTimerLogEntry *entry=nullptr)
 Record a timing event and capture wall time and cpu ticks. More...
 
static vtkTimerLogEntryGetEvent (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 std::vector< vtkTimerLogEntryTimerLog
 
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 91 of file vtkTimerLog.h.

Member Typedef Documentation

Definition at line 96 of file vtkTimerLog.h.

Constructor & Destructor Documentation

vtkTimerLog::vtkTimerLog ( )
inlineprotected

Definition at line 216 of file vtkTimerLog.h.

vtkTimerLog::~vtkTimerLog ( )
inlineoverrideprotected

Definition at line 217 of file vtkTimerLog.h.

Member Function Documentation

static vtkTimerLog* vtkTimerLog::New ( )
static
static int vtkTimerLog::IsTypeOf ( const char *  type)
static
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.

static vtkTimerLog* vtkTimerLog::SafeDownCast ( vtkObjectBase o)
static
virtual vtkObjectBase* vtkTimerLog::NewInstanceInternal ( ) const
protectedvirtual
vtkTimerLog* vtkTimerLog::NewInstance ( ) const
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.

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 103 of file vtkTimerLog.h.

static int vtkTimerLog::GetLogging ( )
inlinestatic

Definition at line 104 of file vtkTimerLog.h.

static void vtkTimerLog::LoggingOn ( )
inlinestatic

Definition at line 105 of file vtkTimerLog.h.

static void vtkTimerLog::LoggingOff ( )
inlinestatic

Definition at line 106 of file vtkTimerLog.h.

static void vtkTimerLog::SetMaxEntries ( int  a)
static

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

static int vtkTimerLog::GetMaxEntries ( )
static

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

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

Record a timing event.

The event is represented by a formatted string.

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.

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.

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.

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.

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

Programatic access to events.

Indexed from 0 to num-1.

static int vtkTimerLog::GetEventIndent ( int  i)
static

Programatic access to events.

Indexed from 0 to num-1.

static double vtkTimerLog::GetEventWallTime ( int  i)
static

Programatic access to events.

Indexed from 0 to num-1.

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

Programatic access to events.

Indexed from 0 to num-1.

static vtkTimerLogEntry::LogEntryType vtkTimerLog::GetEventType ( int  i)
static

Programatic access to events.

Indexed from 0 to num-1.

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

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

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.

static void vtkTimerLog::AllocateLog ( )
static

Allocate timing table with MaxEntries elements.

Deprecated:
AllocateLog() should be replaced with SetMaxEntries() (VTK 7.1.0).
static void vtkTimerLog::CleanupLog ( )
static

Remove timer log.

static double vtkTimerLog::GetUniversalTime ( )
static

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

This is also called Universal Coordinated Time.

static double vtkTimerLog::GetCPUTime ( )
static

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

void vtkTimerLog::StartTimer ( )

Set the StartTime to the current time.

Used with GetElapsedTime().

void vtkTimerLog::StopTimer ( )

Sets EndTime to the current time.

Used with GetElapsedTime().

double vtkTimerLog::GetElapsedTime ( )

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

static void vtkTimerLog::MarkEventInternal ( const char *  EventString,
vtkTimerLogEntry::LogEntryType  type,
vtkTimerLogEntry entry = nullptr 
)
staticprotected

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

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

Member Data Documentation

int vtkTimerLog::Logging
staticprotected

Definition at line 217 of file vtkTimerLog.h.

int vtkTimerLog::Indent
staticprotected

Definition at line 220 of file vtkTimerLog.h.

int vtkTimerLog::MaxEntries
staticprotected

Definition at line 221 of file vtkTimerLog.h.

int vtkTimerLog::NextEntry
staticprotected

Definition at line 222 of file vtkTimerLog.h.

int vtkTimerLog::WrapFlag
staticprotected

Definition at line 223 of file vtkTimerLog.h.

int vtkTimerLog::TicksPerSecond
staticprotected

Definition at line 224 of file vtkTimerLog.h.

std::vector<vtkTimerLogEntry> vtkTimerLog::TimerLog
staticprotected

Definition at line 225 of file vtkTimerLog.h.

timeval vtkTimerLog::FirstWallTime
staticprotected

Definition at line 236 of file vtkTimerLog.h.

timeval vtkTimerLog::CurrentWallTime
staticprotected

Definition at line 237 of file vtkTimerLog.h.

tms vtkTimerLog::FirstCpuTicks
staticprotected

Definition at line 238 of file vtkTimerLog.h.

tms vtkTimerLog::CurrentCpuTicks
staticprotected

Definition at line 239 of file vtkTimerLog.h.

double vtkTimerLog::StartTime
protected

Definition at line 251 of file vtkTimerLog.h.

double vtkTimerLog::EndTime
protected

Definition at line 252 of file vtkTimerLog.h.


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