ITK  4.6.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Private Types | Private Member Functions | Private Attributes | Friends | List of all members
itk::RealTimeStamp Class Reference

#include <itkRealTimeStamp.h>

Detailed Description

The RealTimeStamp is a data structure for representing time with high precision and a large dynamic range.

This class represents time typically for applications that need to mark the time of acquisition of data with high precision (microseconds) and a large dynamic range (years).

By default, the real time stamp is initialized to the origin of the Unix epoch. That is the time 00:00:00 UTC on 1 January 1970 (or 1970-01-01T00:00:00Z ISO 8601)

See Also
RealTimeInterval
RealTimeClock

Definition at line 45 of file itkRealTimeStamp.h.

Public Types

typedef RealTimeStamp Self
 
typedef
RealTimeInterval::TimeRepresentationType 
TimeRepresentationType
 

Public Member Functions

 RealTimeStamp ()
 
 ~RealTimeStamp ()
 
TimeRepresentationType GetTimeInMicroSeconds () const
 
TimeRepresentationType GetTimeInMilliSeconds () const
 
TimeRepresentationType GetTimeInSeconds () const
 
TimeRepresentationType GetTimeInMinutes () const
 
TimeRepresentationType GetTimeInHours () const
 
TimeRepresentationType GetTimeInDays () const
 
RealTimeInterval operator- (const Self &) const
 
Self operator+ (const RealTimeInterval &) const
 
Self operator- (const RealTimeInterval &) const
 
const Selfoperator+= (const RealTimeInterval &)
 
const Selfoperator-= (const RealTimeInterval &)
 
bool operator> (const Self &) const
 
bool operator< (const Self &) const
 
bool operator== (const Self &) const
 
bool operator!= (const Self &) const
 
bool operator<= (const Self &) const
 
bool operator>= (const Self &) const
 

Private Types

typedef uint64_t MicroSecondsCounterType
 
typedef
RealTimeInterval::MicroSecondsDifferenceType 
MicroSecondsDifferenceType
 
typedef uint64_t SecondsCounterType
 
typedef
RealTimeInterval::SecondsDifferenceType 
SecondsDifferenceType
 

Private Member Functions

 RealTimeStamp (SecondsCounterType, MicroSecondsCounterType)
 

Private Attributes

MicroSecondsCounterType m_MicroSeconds
 
SecondsCounterType m_Seconds
 

Friends

ITKCommon_EXPORT std::ostream & operator<< (std::ostream &os, const RealTimeStamp &v)
 
class RealTimeClock
 

Member Typedef Documentation

Definition at line 94 of file itkRealTimeStamp.h.

Definition at line 100 of file itkRealTimeStamp.h.

Definition at line 93 of file itkRealTimeStamp.h.

Definition at line 99 of file itkRealTimeStamp.h.

Definition at line 49 of file itkRealTimeStamp.h.

Native type used to represent the time in different time units.

Definition at line 60 of file itkRealTimeStamp.h.

Constructor & Destructor Documentation

itk::RealTimeStamp::RealTimeStamp ( )

Constructor

itk::RealTimeStamp::~RealTimeStamp ( )

Destructor

itk::RealTimeStamp::RealTimeStamp ( SecondsCounterType  ,
MicroSecondsCounterType   
)
private

Constructor with values. Intentionally made private

Member Function Documentation

TimeRepresentationType itk::RealTimeStamp::GetTimeInDays ( ) const

Return time in multiple units.

TimeRepresentationType itk::RealTimeStamp::GetTimeInHours ( ) const

Return time in multiple units.

TimeRepresentationType itk::RealTimeStamp::GetTimeInMicroSeconds ( ) const

Return time in multiple units.

TimeRepresentationType itk::RealTimeStamp::GetTimeInMilliSeconds ( ) const

Return time in multiple units.

TimeRepresentationType itk::RealTimeStamp::GetTimeInMinutes ( ) const

Return time in multiple units.

TimeRepresentationType itk::RealTimeStamp::GetTimeInSeconds ( ) const

Return time in multiple units.

bool itk::RealTimeStamp::operator!= ( const Self ) const

Comparison operations.

Self itk::RealTimeStamp::operator+ ( const RealTimeInterval ) const

Arithmetic operations between RealTimeInterval and RealTimeStamp.

const Self& itk::RealTimeStamp::operator+= ( const RealTimeInterval )

Arithmetic operations between RealTimeInterval and RealTimeStamp.

RealTimeInterval itk::RealTimeStamp::operator- ( const Self ) const

Arithmetic operations between RealTimeInterval and RealTimeStamp.

Self itk::RealTimeStamp::operator- ( const RealTimeInterval ) const

Arithmetic operations between RealTimeInterval and RealTimeStamp.

const Self& itk::RealTimeStamp::operator-= ( const RealTimeInterval )

Arithmetic operations between RealTimeInterval and RealTimeStamp.

bool itk::RealTimeStamp::operator< ( const Self ) const

Comparison operations.

bool itk::RealTimeStamp::operator<= ( const Self ) const

Comparison operations.

bool itk::RealTimeStamp::operator== ( const Self ) const

Comparison operations.

bool itk::RealTimeStamp::operator> ( const Self ) const

Comparison operations.

bool itk::RealTimeStamp::operator>= ( const Self ) const

Comparison operations.

Friends And Related Function Documentation

ITKCommon_EXPORT std::ostream& operator<< ( std::ostream &  os,
const RealTimeStamp v 
)
friend

Default print out of a RealTimeStamp

friend class RealTimeClock
friend

Definition at line 51 of file itkRealTimeStamp.h.

Member Data Documentation

MicroSecondsCounterType itk::RealTimeStamp::m_MicroSeconds
private

Definition at line 104 of file itkRealTimeStamp.h.

SecondsCounterType itk::RealTimeStamp::m_Seconds
private

Number of Seconds and Microseconds since...

Definition at line 103 of file itkRealTimeStamp.h.


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