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.

Created by:

Martin, Ken

CVS contributions (if > 5%):

Martin, Ken (40%)
Schroeder, Will (32%)
Lorensen, Bill (9%)
Law, Charles (5%)

CVS logs (CVSweb):

.h (/Common/vtkTimeStamp.h)
.cxx (/Common/vtkTimeStamp.cxx)

Tests:: vtkTimeStamp (Tests)

Definition at line 46 of file vtkTimeStamp.h.

Public Member Functions

vtkTimeStamp ()

void Delete ()

virtual const char * GetClassName ()

void Modified ()

unsigned long int GetMTime ()

operator unsigned long ()

int operator> (vtkTimeStamp &ts)

int operator< (vtkTimeStamp &ts)

Static Public Member Functions

vtkTimeStamp * New ()

Constructor & Destructor Documentation

vtkTimeStamp::vtkTimeStamp ( ) [inline]

Definition at line 49 of file vtkTimeStamp.h.

Member Function Documentation

vtkTimeStamp* vtkTimeStamp::New ( ) [static]

void vtkTimeStamp::Delete ( ) [inline]

Definition at line 51 of file vtkTimeStamp.h.

virtual const char* vtkTimeStamp::GetClassName ( ) [inline, virtual]

Definition at line 53 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.
Referenced by vtkLookupTable::WritePointer().

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

Return this object's Modified time.
Definition at line 65 of file vtkTimeStamp.h.

int vtkTimeStamp::operator> ( vtkTimeStamp & ts ) [inline]

Support comparisons of time stamp objects directly.
Definition at line 69 of file vtkTimeStamp.h.
References ModifiedTime.

int vtkTimeStamp::operator< ( vtkTimeStamp & ts ) [inline]

Support comparisons of time stamp objects directly.
Definition at line 71 of file vtkTimeStamp.h.
References ModifiedTime.

vtkTimeStamp::operator unsigned long ( ) [inline]

Allow for typecasting to unsigned long.
Definition at line 76 of file vtkTimeStamp.h.

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

dox/Common/vtkTimeStamp.h


Public Member Functions
	vtkTimeStamp ()
void	Delete ()
virtual const char *	GetClassName ()
void	Modified ()
unsigned long int	GetMTime ()
	operator unsigned long ()

int	operator> (vtkTimeStamp &ts)
int	operator< (vtkTimeStamp &ts)
Static Public Member Functions
vtkTimeStamp *	New ()