ITK  5.4.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Private Member Functions | Private Attributes | Static Private Attributes | List of all members
itk::TimeStamp Class Reference

#include <itkTimeStamp.h>

Detailed Description

Generate a unique, increasing time value.

TimeStamp 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 TimeStamp objects.

On most platforms, this class uses a lock-free incremental counter. The Modified function can safely be called simultaneously by multiple threads on different instances of the class. However, calling the Modified function by different threads on the same instance of the class can lead to some unexpected behavior. The global counter will always be correct but the local m_ModifiedTime might not (see for more detail).

Definition at line 60 of file itkTimeStamp.h.

Public Types

using GlobalTimeStampType = std::atomic< ModifiedTimeType >
using Self = TimeStamp

Public Member Functions

void Delete ()
ModifiedTimeType GetMTime () const
void Modified ()
 operator ModifiedTimeType () const
bool operator> (TimeStamp &ts) const
bool operator< (TimeStamp &ts) const

Static Public Member Functions

static const char * GetNameOfClass ()
static SelfNew ()

Private Member Functions

 itkGetGlobalDeclarationMacro (GlobalTimeStampType, GlobalTimeStamp)

Private Attributes

ModifiedTimeType m_ModifiedTime { 0 }

Static Private Attributes

static GlobalTimeStampTypem_GlobalTimeStamp

Member Typedef Documentation

◆ GlobalTimeStampType

Definition at line 66 of file itkTimeStamp.h.

◆ Self

Standard class type aliases.

Definition at line 64 of file itkTimeStamp.h.

Member Function Documentation

◆ Delete()

void itk::TimeStamp::Delete ( )

Destroy this instance.

Definition at line 75 of file itkTimeStamp.h.

◆ GetMTime()

ModifiedTimeType itk::TimeStamp::GetMTime ( ) const

Return this object's Modified time.

Definition at line 99 of file itkTimeStamp.h.

◆ GetNameOfClass()

static const char* itk::TimeStamp::GetNameOfClass ( )

The class name as a string.

Definition at line 82 of file itkTimeStamp.h.

◆ itkGetGlobalDeclarationMacro()

itk::TimeStamp::itkGetGlobalDeclarationMacro ( GlobalTimeStampType  ,

Set/Get the pointer to GlobalTimeStamp. Note that SetGlobalTimeStamp is not concurrent thread safe.

◆ Modified()

void itk::TimeStamp::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.

◆ New()

static Self* itk::TimeStamp::New ( )

Create an instance of this class. We don't want to use reference counting.

◆ operator ModifiedTimeType()

itk::TimeStamp::operator ModifiedTimeType ( ) const

Allow for typecasting to unsigned long.

Definition at line 118 of file itkTimeStamp.h.

◆ operator<()

bool itk::TimeStamp::operator< ( TimeStamp ts) const

Support comparisons of time stamp objects directly.

Definition at line 111 of file itkTimeStamp.h.

References m_ModifiedTime.

◆ operator>()

bool itk::TimeStamp::operator> ( TimeStamp ts) const

Support comparisons of time stamp objects directly.

Definition at line 106 of file itkTimeStamp.h.

References m_ModifiedTime.

Member Data Documentation

◆ m_GlobalTimeStamp

GlobalTimeStampType* itk::TimeStamp::m_GlobalTimeStamp

The static GlobalTimeStamp. This is initialized to NULL as the first stage of static initialization. It is then populated on the first call to itk::TimeStamp::Modified() but it can be overridden with SetGlobalTimeStamp().

Definition at line 131 of file itkTimeStamp.h.

◆ m_ModifiedTime

ModifiedTimeType itk::TimeStamp::m_ModifiedTime { 0 }

Definition at line 125 of file itkTimeStamp.h.

Referenced by operator<(), and operator>().

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