ActiViz .NET  5.8.0
Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | Protected Member Functions | Private Member Functions | Static Private Member Functions
Kitware.VTK.vtkTimerLog Class Reference

vtkTimerLog - Timer support and logging More...

Inheritance diagram for Kitware.VTK.vtkTimerLog:
[legend]
Collaboration diagram for Kitware.VTK.vtkTimerLog:
[legend]

List of all members.

Public Member Functions

 vtkTimerLog (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkTimerLog ()
 Undocumented Block.
double GetElapsedTime ()
 Returns the difference between StartTime and EndTime as a doubleing point value indicating the elapsed time in seconds.
override int IsA (string type)
 Undocumented Block.
new vtkTimerLog NewInstance ()
 Undocumented Block.
void StartTimer ()
 Set the StartTime to the current time. Used with GetElapsedTime().
void StopTimer ()
 Sets EndTime to the current time. Used with GetElapsedTime().

Static Public Member Functions

static new vtkTimerLog New ()
 Undocumented Block.
static void AllocateLog ()
 Allocate timing table with MaxEntries elements.
static void CleanupLog ()
 Remove timer log.
static void DumpLog (string filename)
 Write the timing table out to a file. Calculate some helpful statistics (deltas and percentages) in the process.
static void FormatAndMarkEvent (string EventString)
 Set/Get the maximum number of entries allowed in the timer log.
static double GetCPUTime ()
 Returns the CPU time for this process On Win32 platforms this actually returns wall time.
static int GetEventIndent (int i)
 Programatic access to events. Indexed from 0 to num-1.
static string GetEventString (int i)
 Programatic access to events. Indexed from 0 to num-1.
static double GetEventWallTime (int i)
 Programatic access to events. Indexed from 0 to num-1.
static int GetLogging ()
 This flag will turn loging of events off or on. By default, logging is on.
static int GetMaxEntries ()
 Set/Get the maximum number of entries allowed in the timer log.
static int GetNumberOfEvents ()
 Programatic access to events. Indexed from 0 to num-1.
static double GetUniversalTime ()
 Returns the elapsed number of seconds since January 1, 1970. This is also called Universal Coordinated Time.
static new int IsTypeOf (string type)
 Undocumented Block.
static void LoggingOff ()
 This flag will turn loging of events off or on. By default, logging is on.
static void LoggingOn ()
 This flag will turn loging of events off or on. By default, logging is on.
static void MarkEndEvent (string EventString)
 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 MarkEvent (string EventString)
 Record a timing event and capture wall time and cpu ticks.
static void MarkStartEvent (string EventString)
 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 ResetLog ()
 Clear the timing table. walltime and cputime will also be set to zero when the first new event is recorded.
static new vtkTimerLog SafeDownCast (vtkObjectBase o)
 Undocumented Block.
static void SetLogging (int v)
 This flag will turn loging of events off or on. By default, logging is on.
static void SetMaxEntries (int a)
 Set/Get the maximum number of entries allowed in the timer log.

Public Attributes

new const string MRFullTypeName = "Kitware.VTK.vtkTimerLog"
 Automatically generated type registration mechanics.

Static Public Attributes

static new readonly string MRClassNameKey = "11vtkTimerLog"
 Automatically generated type registration mechanics.

Protected Member Functions

override void Dispose (bool disposing)
 Automatically generated protected Dispose method - called from public Dispose or the C# destructor. DO NOT call directly.

Private Member Functions

static internal IntPtr vtkTimerLog_New (ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkTimerLog_AllocateLog_01 ()
static internal void vtkTimerLog_CleanupLog_02 ()
static internal void vtkTimerLog_DumpLog_03 (string filename)
static internal void vtkTimerLog_FormatAndMarkEvent_04 (string EventString)
static internal double vtkTimerLog_GetCPUTime_05 ()
static internal double vtkTimerLog_GetElapsedTime_06 (HandleRef pThis)
static internal int vtkTimerLog_GetEventIndent_07 (int i)
static internal IntPtr vtkTimerLog_GetEventString_08 (int i)
static internal double vtkTimerLog_GetEventWallTime_09 (int i)
static internal int vtkTimerLog_GetLogging_10 ()
static internal int vtkTimerLog_GetMaxEntries_11 ()
static internal int vtkTimerLog_GetNumberOfEvents_12 ()
static internal double vtkTimerLog_GetUniversalTime_13 ()
static internal int vtkTimerLog_IsA_14 (HandleRef pThis, string type)
static internal int vtkTimerLog_IsTypeOf_15 (string type)
static internal void vtkTimerLog_LoggingOff_16 ()
static internal void vtkTimerLog_LoggingOn_17 ()
static internal void vtkTimerLog_MarkEndEvent_18 (string EventString)
static internal void vtkTimerLog_MarkEvent_19 (string EventString)
static internal void vtkTimerLog_MarkStartEvent_20 (string EventString)
static internal IntPtr vtkTimerLog_NewInstance_22 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkTimerLog_ResetLog_23 ()
static internal IntPtr vtkTimerLog_SafeDownCast_24 (HandleRef o, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkTimerLog_SetLogging_25 (int v)
static internal void vtkTimerLog_SetMaxEntries_26 (int a)
static internal void vtkTimerLog_StartTimer_27 (HandleRef pThis)
static internal void vtkTimerLog_StopTimer_28 (HandleRef pThis)

Static Private Member Functions

static vtkTimerLog ()
 Automatically generated type registration mechanics.

Detailed Description

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.


Constructor & Destructor Documentation

static Kitware.VTK.vtkTimerLog.vtkTimerLog ( ) [static, private]

Automatically generated type registration mechanics.

Kitware.VTK.vtkTimerLog.vtkTimerLog ( IntPtr  rawCppThis,
bool  callDisposalMethod,
bool  strong 
)

Automatically generated constructor - called from generated code. DO NOT call directly.

Undocumented Block.


Member Function Documentation

static void Kitware.VTK.vtkTimerLog.AllocateLog ( ) [static]

Allocate timing table with MaxEntries elements.

static void Kitware.VTK.vtkTimerLog.CleanupLog ( ) [static]

Remove timer log.

override void Kitware.VTK.vtkTimerLog.Dispose ( bool  disposing) [protected]

Automatically generated protected Dispose method - called from public Dispose or the C# destructor. DO NOT call directly.

Reimplemented from Kitware.VTK.vtkObject.

static void Kitware.VTK.vtkTimerLog.DumpLog ( string  filename) [static]

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

static void Kitware.VTK.vtkTimerLog.FormatAndMarkEvent ( string  EventString) [static]

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

static double Kitware.VTK.vtkTimerLog.GetCPUTime ( ) [static]

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

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

static int Kitware.VTK.vtkTimerLog.GetEventIndent ( int  i) [static]

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

static string Kitware.VTK.vtkTimerLog.GetEventString ( int  i) [static]

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

static double Kitware.VTK.vtkTimerLog.GetEventWallTime ( int  i) [static]

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

static int Kitware.VTK.vtkTimerLog.GetLogging ( ) [static]

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

static int Kitware.VTK.vtkTimerLog.GetMaxEntries ( ) [static]

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

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

static double Kitware.VTK.vtkTimerLog.GetUniversalTime ( ) [static]

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

override int Kitware.VTK.vtkTimerLog.IsA ( string  type) [virtual]

Undocumented Block.

Reimplemented from Kitware.VTK.vtkObject.

static new int Kitware.VTK.vtkTimerLog.IsTypeOf ( string  type) [static]

Undocumented Block.

Reimplemented from Kitware.VTK.vtkObject.

static void Kitware.VTK.vtkTimerLog.LoggingOff ( ) [static]

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

static void Kitware.VTK.vtkTimerLog.LoggingOn ( ) [static]

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

static void Kitware.VTK.vtkTimerLog.MarkEndEvent ( string  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 Kitware.VTK.vtkTimerLog.MarkEvent ( string  EventString) [static]

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

static void Kitware.VTK.vtkTimerLog.MarkStartEvent ( string  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 new vtkTimerLog Kitware.VTK.vtkTimerLog.New ( ) [static]

Undocumented Block.

Reimplemented from Kitware.VTK.vtkObject.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkObject.

static void Kitware.VTK.vtkTimerLog.ResetLog ( ) [static]

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

Undocumented Block.

Reimplemented from Kitware.VTK.vtkObject.

Here is the call graph for this function:

static void Kitware.VTK.vtkTimerLog.SetLogging ( int  v) [static]

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

static void Kitware.VTK.vtkTimerLog.SetMaxEntries ( int  a) [static]

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

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

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

static internal void Kitware.VTK.vtkTimerLog.vtkTimerLog_AllocateLog_01 ( ) [private]
static internal void Kitware.VTK.vtkTimerLog.vtkTimerLog_CleanupLog_02 ( ) [private]
static internal void Kitware.VTK.vtkTimerLog.vtkTimerLog_DumpLog_03 ( string  filename) [private]
static internal void Kitware.VTK.vtkTimerLog.vtkTimerLog_FormatAndMarkEvent_04 ( string  EventString) [private]
static internal double Kitware.VTK.vtkTimerLog.vtkTimerLog_GetCPUTime_05 ( ) [private]
static internal double Kitware.VTK.vtkTimerLog.vtkTimerLog_GetElapsedTime_06 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkTimerLog.vtkTimerLog_GetEventIndent_07 ( int  i) [private]
static internal IntPtr Kitware.VTK.vtkTimerLog.vtkTimerLog_GetEventString_08 ( int  i) [private]
static internal double Kitware.VTK.vtkTimerLog.vtkTimerLog_GetEventWallTime_09 ( int  i) [private]
static internal int Kitware.VTK.vtkTimerLog.vtkTimerLog_GetLogging_10 ( ) [private]
static internal int Kitware.VTK.vtkTimerLog.vtkTimerLog_GetMaxEntries_11 ( ) [private]
static internal double Kitware.VTK.vtkTimerLog.vtkTimerLog_GetUniversalTime_13 ( ) [private]
static internal int Kitware.VTK.vtkTimerLog.vtkTimerLog_IsA_14 ( HandleRef  pThis,
string  type 
) [private]
static internal int Kitware.VTK.vtkTimerLog.vtkTimerLog_IsTypeOf_15 ( string  type) [private]
static internal void Kitware.VTK.vtkTimerLog.vtkTimerLog_LoggingOff_16 ( ) [private]
static internal void Kitware.VTK.vtkTimerLog.vtkTimerLog_LoggingOn_17 ( ) [private]
static internal void Kitware.VTK.vtkTimerLog.vtkTimerLog_MarkEndEvent_18 ( string  EventString) [private]
static internal void Kitware.VTK.vtkTimerLog.vtkTimerLog_MarkEvent_19 ( string  EventString) [private]
static internal void Kitware.VTK.vtkTimerLog.vtkTimerLog_MarkStartEvent_20 ( string  EventString) [private]
static internal IntPtr Kitware.VTK.vtkTimerLog.vtkTimerLog_New ( ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkTimerLog.vtkTimerLog_NewInstance_22 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkTimerLog.vtkTimerLog_ResetLog_23 ( ) [private]
static internal IntPtr Kitware.VTK.vtkTimerLog.vtkTimerLog_SafeDownCast_24 ( HandleRef  o,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkTimerLog.vtkTimerLog_SetLogging_25 ( int  v) [private]
static internal void Kitware.VTK.vtkTimerLog.vtkTimerLog_SetMaxEntries_26 ( int  a) [private]
static internal void Kitware.VTK.vtkTimerLog.vtkTimerLog_StartTimer_27 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkTimerLog.vtkTimerLog_StopTimer_28 ( HandleRef  pThis) [private]

Member Data Documentation

new readonly string Kitware.VTK.vtkTimerLog.MRClassNameKey = "11vtkTimerLog" [static]

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkObject.

new const string Kitware.VTK.vtkTimerLog.MRFullTypeName = "Kitware.VTK.vtkTimerLog"

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkObject.


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