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.

Warning

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 https://www.itk.org/mailman/private/insight-developers/2009-February/011732.html 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
Self &	operator= (const Self &other)=default
	TimeStamp ()
bool	operator> (TimeStamp &ts)
bool	operator< (TimeStamp &ts)

Static Public Member Functions
static const char *	GetNameOfClass ()
static Self *	New ()

Private Member Functions
	itkGetGlobalDeclarationMacro (GlobalTimeStampType, GlobalTimeStamp)

Private Attributes
ModifiedTimeType	m_ModifiedTime

Static Private Attributes
static GlobalTimeStampType *	m_GlobalTimeStamp

Member Typedef Documentation

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

Definition at line 66 of file itkTimeStamp.h.

using itk::TimeStamp::Self = TimeStamp

Standard class type aliases.

Definition at line 64 of file itkTimeStamp.h.

Constructor & Destructor Documentation

itk::TimeStamp::TimeStamp ( )

inline

Constructor must remain public because classes instantiate TimeStamps implicitly in their construction.

Definition at line 74 of file itkTimeStamp.h.

Member Function Documentation

void itk::TimeStamp::Delete ( )

inline

Destoy this instance.

Definition at line 78 of file itkTimeStamp.h.

ModifiedTimeType itk::TimeStamp::GetMTime ( ) const

inline

Return this object's Modified time.

Definition at line 95 of file itkTimeStamp.h.

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

inlinestatic

The class name as a string.

Definition at line 82 of file itkTimeStamp.h.

itk::TimeStamp::itkGetGlobalDeclarationMacro ( GlobalTimeStampType  , GlobalTimeStamp    )

private

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

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.

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

static

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

itk::TimeStamp::operator ModifiedTimeType ( ) const

inline

Allow for typcasting to unsigned long.

Definition at line 106 of file itkTimeStamp.h.

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

inline

Support comparisons of time stamp objects directly.

Definition at line 101 of file itkTimeStamp.h.

References m_ModifiedTime.

Self& itk::TimeStamp::operator= ( const Self &  other )

default

Assignment operator, allows to initialize one time stamp by copying from another.

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

inline

Support comparisons of time stamp objects directly.

Definition at line 99 of file itkTimeStamp.h.

References m_ModifiedTime.

Member Data Documentation

GlobalTimeStampType* itk::TimeStamp::m_GlobalTimeStamp

staticprivate

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 124 of file itkTimeStamp.h.

ModifiedTimeType itk::TimeStamp::m_ModifiedTime

private

Definition at line 118 of file itkTimeStamp.h.

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

---

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

• itkTimeStamp.h