1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
|
/*=========================================================================
*
* Copyright NumFOCUS
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0.txt
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
*=========================================================================*/
#ifndef itkRealTimeInterval_h
#define itkRealTimeInterval_h
#include "itkIntTypes.h"
#include "itkMacro.h"
#include <iostream>
namespace itk
{
/** \class RealTimeInterval
* \brief 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.
*
* \sa RealTimeStamp
* \sa RealTimeClock
*
* \ingroup ITKCommon
*/
class ITKCommon_EXPORT RealTimeInterval
{
public:
using Self = RealTimeInterval;
/** Internal types used to represent seconds and microseconds. */
using SecondsDifferenceType = int64_t;
using MicroSecondsDifferenceType = int64_t;
/** Constructor */
RealTimeInterval();
/** Constructor with values. Intentionally made public */
RealTimeInterval(SecondsDifferenceType, MicroSecondsDifferenceType);
/** Destructor */
~RealTimeInterval();
/** Native type used to represent the time in different time units. */
using TimeRepresentationType = double;
/** Return time in multiple units. */
TimeRepresentationType
GetTimeInMicroSeconds() const;
TimeRepresentationType
GetTimeInMilliSeconds() const;
TimeRepresentationType
GetTimeInSeconds() const;
TimeRepresentationType
GetTimeInMinutes() const;
TimeRepresentationType
GetTimeInHours() const;
TimeRepresentationType
GetTimeInDays() const;
/** Arithmetic operations between RealTimeInterval and RealTimeInterval. */
Self
operator-(const Self &) const;
Self
operator+(const Self &) const;
const Self &
operator-=(const Self &);
const Self &
operator+=(const Self &);
/** Comparison operations. */
bool
operator>(const Self &) const;
bool
operator<(const Self &) const;
bool
operator==(const Self &) const;
ITK_UNEQUAL_OPERATOR_MEMBER_FUNCTION(Self);
bool
operator<=(const Self &) const;
bool
operator>=(const Self &) const;
/** Set with values. The units and signs of the seconds and microseconds will
* be harmonized internally. */
void Set(SecondsDifferenceType, MicroSecondsDifferenceType);
/** Default print out of a RealTimeInterval */
friend ITKCommon_EXPORT std::ostream &
operator<<(std::ostream & os, const RealTimeInterval & v);
private:
friend class RealTimeStamp;
/** Number of Seconds and Microseconds since... */
SecondsDifferenceType m_Seconds;
/** 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. */
MicroSecondsDifferenceType m_MicroSeconds;
};
} // end of namespace itk
#endif // itkRealTimeInterval_h
|
