vtkTimeStamp Class Reference

#include <vtkTimeStamp.h>

List of all members.

Detailed Description

record modification and/or execution time

vtkTimeStamp records a unique time when the method Modified() is executed. This time is guaranteed to be monotonically increasing. Classes use this object to record modified and/or execution time. There is built in support for the binary < and > comparison operators between two vtkTimeStamp objects.

vtkTimeStamp (Tests)

Definition at line 33 of file vtkTimeStamp.h.

Public Member Functions

 vtkTimeStamp ()
void Delete ()
void Modified ()
unsigned long GetMTime () const
 operator unsigned long () const
bool operator> (vtkTimeStamp &ts)
bool operator< (vtkTimeStamp &ts)

Static Public Member Functions

static vtkTimeStampNew ()

Constructor & Destructor Documentation

vtkTimeStamp::vtkTimeStamp (  )  [inline]

Definition at line 36 of file vtkTimeStamp.h.

Member Function Documentation

static vtkTimeStamp* vtkTimeStamp::New (  )  [static]

void vtkTimeStamp::Delete (  )  [inline]

Definition at line 38 of file vtkTimeStamp.h.

void vtkTimeStamp::Modified (  ) 

Set this objects time to the current time. The current time is just a monotonically increasing unsigned long integer. It is possible for this number to wrap around back to zero. This should only happen for processes that have been running for a very long time, while constantly changing objects within the program. When this does occur, the typical consequence should be that some filters will update themselves when really they don't need to.

unsigned long vtkTimeStamp::GetMTime (  )  const [inline]

Return this object's Modified time.

Definition at line 50 of file vtkTimeStamp.h.

bool vtkTimeStamp::operator> ( vtkTimeStamp ts  )  [inline]

Support comparisons of time stamp objects directly.

Definition at line 54 of file vtkTimeStamp.h.

bool vtkTimeStamp::operator< ( vtkTimeStamp ts  )  [inline]

Support comparisons of time stamp objects directly.

Definition at line 56 of file vtkTimeStamp.h.

vtkTimeStamp::operator unsigned long (  )  const [inline]

Allow for typecasting to unsigned long.

Definition at line 61 of file vtkTimeStamp.h.

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

Generated on Wed Jun 3 19:40:17 2009 for VTK by  doxygen 1.5.6