ITK  5.3.0
Insight Toolkit
Public Types | Public Member Functions | Friends | List of all members
itk::RealTimeStamp Class Reference

#include <itkRealTimeStamp.h>

Public Types

using Self = RealTimeStamp
 
using TimeRepresentationType = RealTimeInterval::TimeRepresentationType
 

Public Member Functions

 RealTimeStamp ()
 
 ~RealTimeStamp ()
 

Friends

class RealTimeClock
 
using SecondsCounterType = uint64_t
 
using MicroSecondsCounterType = uint64_t
 
using SecondsDifferenceType = RealTimeInterval::SecondsDifferenceType
 
using MicroSecondsDifferenceType = RealTimeInterval::MicroSecondsDifferenceType
 
ITKCommon_EXPORT std::ostream & operator<< (std::ostream &os, const RealTimeStamp &v)
 
SecondsCounterType m_Seconds
 
MicroSecondsCounterType m_MicroSeconds
 
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
 
 RealTimeStamp (SecondsCounterType, MicroSecondsCounterType)
 

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.

Member Typedef Documentation

◆ MicroSecondsCounterType

Default print out of a RealTimeStamp

Definition at line 110 of file itkRealTimeStamp.h.

◆ MicroSecondsDifferenceType

Default print out of a RealTimeStamp

Definition at line 116 of file itkRealTimeStamp.h.

◆ SecondsCounterType

Default print out of a RealTimeStamp

Definition at line 109 of file itkRealTimeStamp.h.

◆ SecondsDifferenceType

Default print out of a RealTimeStamp

Definition at line 115 of file itkRealTimeStamp.h.

◆ Self

Definition at line 48 of file itkRealTimeStamp.h.

◆ TimeRepresentationType

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

Definition at line 59 of file itkRealTimeStamp.h.

Constructor & Destructor Documentation

◆ RealTimeStamp() [1/2]

itk::RealTimeStamp::RealTimeStamp ( )

Constructor

◆ ~RealTimeStamp()

itk::RealTimeStamp::~RealTimeStamp ( )

Destructor

◆ RealTimeStamp() [2/2]

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

Constructor with values. Intentionally made private

Member Function Documentation

◆ GetTimeInDays()

TimeRepresentationType itk::RealTimeStamp::GetTimeInDays ( ) const

Default print out of a RealTimeStamp

◆ GetTimeInHours()

TimeRepresentationType itk::RealTimeStamp::GetTimeInHours ( ) const

Default print out of a RealTimeStamp

◆ GetTimeInMicroSeconds()

TimeRepresentationType itk::RealTimeStamp::GetTimeInMicroSeconds ( ) const

Return time in multiple units.

◆ GetTimeInMilliSeconds()

TimeRepresentationType itk::RealTimeStamp::GetTimeInMilliSeconds ( ) const

Default print out of a RealTimeStamp

◆ GetTimeInMinutes()

TimeRepresentationType itk::RealTimeStamp::GetTimeInMinutes ( ) const

Default print out of a RealTimeStamp

◆ GetTimeInSeconds()

TimeRepresentationType itk::RealTimeStamp::GetTimeInSeconds ( ) const

Default print out of a RealTimeStamp

◆ operator!=()

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

Default print out of a RealTimeStamp

◆ operator+()

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

Default print out of a RealTimeStamp

◆ operator+=()

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

Default print out of a RealTimeStamp

◆ operator-() [1/2]

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

Default print out of a RealTimeStamp

◆ operator-() [2/2]

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

Arithmetic operations between RealTimeInterval and RealTimeStamp.

◆ operator-=()

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

Default print out of a RealTimeStamp

◆ operator<()

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

Default print out of a RealTimeStamp

◆ operator<=()

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

Default print out of a RealTimeStamp

◆ operator==()

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

Default print out of a RealTimeStamp

◆ operator>()

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

Comparison operations.

◆ operator>=()

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

Default print out of a RealTimeStamp

Friends And Related Function Documentation

◆ operator<<

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

Default print out of a RealTimeStamp

◆ RealTimeClock

friend class RealTimeClock
friend

Definition at line 50 of file itkRealTimeStamp.h.

Member Data Documentation

◆ m_MicroSeconds

MicroSecondsCounterType itk::RealTimeStamp::m_MicroSeconds
private

Default print out of a RealTimeStamp

Definition at line 120 of file itkRealTimeStamp.h.

◆ m_Seconds

SecondsCounterType itk::RealTimeStamp::m_Seconds
private

Number of Seconds and Microseconds since...

Definition at line 119 of file itkRealTimeStamp.h.


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