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

#include <itkRealTimeInterval.h>

Public Types

using MicroSecondsDifferenceType = int64_t
 
using SecondsDifferenceType = int64_t
 
using Self = RealTimeInterval
 
using TimeRepresentationType = double
 

Public Member Functions

 RealTimeInterval ()
 
 RealTimeInterval (SecondsDifferenceType, MicroSecondsDifferenceType)
 
 ~RealTimeInterval ()
 
class RealTimeStamp
 
ITKCommon_EXPORT std::ostream & operator<< (std::ostream &os, const RealTimeInterval &v)
 
SecondsDifferenceType m_Seconds
 
MicroSecondsDifferenceType m_MicroSeconds
 
TimeRepresentationType GetTimeInMicroSeconds () const
 
TimeRepresentationType GetTimeInMilliSeconds () const
 
TimeRepresentationType GetTimeInSeconds () const
 
TimeRepresentationType GetTimeInMinutes () const
 
TimeRepresentationType GetTimeInHours () const
 
TimeRepresentationType GetTimeInDays () const
 
Self operator- (const Self &) const
 
Self operator+ (const Self &) const
 
const Selfoperator-= (const Self &)
 
const Selfoperator+= (const Self &)
 
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
 
void Set (SecondsDifferenceType, MicroSecondsDifferenceType)
 

Detailed Description

A data structure for representing the time span between two RealTimeStamps, with similar high precision and a large dynamic range to what the RealTimeStamps offer.

This class represents the difference between two time points, typically for applications that need to mark the time of acquisition of data with high precision (microseconds) and a large dynamic range (years). This class will be the natural representation for the duration of a video sequence, or for the time that has passed between the acquisition of one images and a subsequent one.

See also
RealTimeStamp
RealTimeClock

Definition at line 45 of file itkRealTimeInterval.h.

Member Typedef Documentation

◆ MicroSecondsDifferenceType

Definition at line 52 of file itkRealTimeInterval.h.

◆ SecondsDifferenceType

Internal types used to represent seconds and microseconds.

Definition at line 51 of file itkRealTimeInterval.h.

◆ Self

Definition at line 48 of file itkRealTimeInterval.h.

◆ TimeRepresentationType

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

Definition at line 64 of file itkRealTimeInterval.h.

Constructor & Destructor Documentation

◆ RealTimeInterval() [1/2]

itk::RealTimeInterval::RealTimeInterval ( )

Constructor

◆ RealTimeInterval() [2/2]

itk::RealTimeInterval::RealTimeInterval ( SecondsDifferenceType  ,
MicroSecondsDifferenceType   
)

Constructor with values. Intentionally made public

◆ ~RealTimeInterval()

itk::RealTimeInterval::~RealTimeInterval ( )

Destructor

Member Function Documentation

◆ GetTimeInDays()

TimeRepresentationType itk::RealTimeInterval::GetTimeInDays ( ) const

Default print out of a RealTimeInterval

◆ GetTimeInHours()

TimeRepresentationType itk::RealTimeInterval::GetTimeInHours ( ) const

Default print out of a RealTimeInterval

◆ GetTimeInMicroSeconds()

TimeRepresentationType itk::RealTimeInterval::GetTimeInMicroSeconds ( ) const

Return time in multiple units.

◆ GetTimeInMilliSeconds()

TimeRepresentationType itk::RealTimeInterval::GetTimeInMilliSeconds ( ) const

Default print out of a RealTimeInterval

◆ GetTimeInMinutes()

TimeRepresentationType itk::RealTimeInterval::GetTimeInMinutes ( ) const

Default print out of a RealTimeInterval

◆ GetTimeInSeconds()

TimeRepresentationType itk::RealTimeInterval::GetTimeInSeconds ( ) const

Default print out of a RealTimeInterval

◆ operator!=()

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

Default print out of a RealTimeInterval

◆ operator+()

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

Default print out of a RealTimeInterval

◆ operator+=()

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

Default print out of a RealTimeInterval

◆ operator-()

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

Arithmetic operations between RealTimeInterval and RealTimeInterval.

◆ operator-=()

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

Default print out of a RealTimeInterval

◆ operator<()

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

Default print out of a RealTimeInterval

◆ operator<=()

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

Default print out of a RealTimeInterval

◆ operator==()

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

Default print out of a RealTimeInterval

◆ operator>()

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

Comparison operations.

◆ operator>=()

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

Default print out of a RealTimeInterval

◆ Set()

void itk::RealTimeInterval::Set ( SecondsDifferenceType  ,
MicroSecondsDifferenceType   
)

Set with values. The units and signs of the seconds and microseconds will be harmonized internally.

Friends And Related Function Documentation

◆ operator<<

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

Default print out of a RealTimeInterval

◆ RealTimeStamp

friend class RealTimeStamp
friend

Default print out of a RealTimeInterval

Definition at line 116 of file itkRealTimeInterval.h.

Member Data Documentation

◆ m_MicroSeconds

MicroSecondsDifferenceType itk::RealTimeInterval::m_MicroSeconds
private

Number of Microseconds since the second. Should be in the range -999,999 to 999,999 and it must always have the same sign as the m_Seconds member variable.

Definition at line 125 of file itkRealTimeInterval.h.

◆ m_Seconds

SecondsDifferenceType itk::RealTimeInterval::m_Seconds
private

Number of Seconds and Microseconds since...

Definition at line 119 of file itkRealTimeInterval.h.


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