The Gaudi Framework  v28r3 (cc1cf868)
Gaudi::TimeSpan Class Reference

Based on seal::TimeSpan. More...

#include <GaudiKernel/Time.h>

Collaboration diagram for Gaudi::TimeSpan:

Public Types

typedef longlong ValueType
 

Public Member Functions

 TimeSpan ()=default
 Initialize an empty (zero) time difference. More...
 
 TimeSpan (Time t)
 Initialize a time span from Time t. More...
 
 TimeSpan (ValueType nsecs)
 Initialize a time span to a specific length. More...
 
 TimeSpan (ValueType secs, int nsecs)
 Initialise a time span to a specific length. More...
 
 TimeSpan (int days, int hours, int mins, int secs, int nsecs)
 Initialise a time span to a specific length. More...
 
int days () const
 Get the number of complete days in the span. More...
 
int hours () const
 Get the number of complete hours in the span. More...
 
int minutes () const
 Get the number of complete minutes in the span. More...
 
ValueType seconds () const
 Get the number of complete seconds in the span. More...
 
int lastHours () const
 Get the number of complete hours in the last incomplete day of the span. More...
 
int lastMinutes () const
 Get the number of complete minutes in the last incomplete hour of the span. More...
 
int lastSeconds () const
 Get the number of complete seconds in the last incomplete minute of the span. More...
 
int lastNSeconds () const
 Get the number of nanoseconds in the last incomplete second of the span. More...
 
TimeSpanoperator+= (const TimeSpan &x)
 Add to a time span. More...
 
TimeSpanoperator-= (const TimeSpan &x)
 Subtract from a time span. More...
 
TimeSpanoperator*= (const TimeSpan &n)
 Multiply a time span. More...
 
TimeSpanoperator/= (const TimeSpan &n)
 Divide a time span. More...
 
TimeSpanoperator%= (const TimeSpan &n)
 Compute a modulo of a time span. More...
 
ValueType ns () const
 Return the time span as nanoseconds. More...
 

Private Attributes

ValueType m_nsecs = 0
 

Friends

class Time
 
bool operator== (const Gaudi::TimeSpan &t1, const Gaudi::TimeSpan &t2)
 
bool operator!= (const Gaudi::TimeSpan &t1, const Gaudi::TimeSpan &t2)
 
bool operator< (const Gaudi::TimeSpan &t1, const Gaudi::TimeSpan &t2)
 
bool operator<= (const Gaudi::TimeSpan &t1, const Gaudi::TimeSpan &t2)
 
bool operator> (const Gaudi::TimeSpan &t1, const Gaudi::TimeSpan &t2)
 
bool operator>= (const Gaudi::TimeSpan &t1, const Gaudi::TimeSpan &t2)
 
Gaudi::TimeSpan operator+ (const Gaudi::TimeSpan &ts1, const Gaudi::TimeSpan &ts2)
 
Gaudi::TimeSpan operator- (const Gaudi::TimeSpan &ts1, const Gaudi::TimeSpan &ts2)
 

Detailed Description

Based on seal::TimeSpan.

A difference between two Time values. In addition to supporting normal integer artihmetic and comparisons, the span can also be converted to a number useful units.

See also
Time.

(Documentation taken from original SEAL class)

Author
Marco Clemencic
Date
2005-12-15

Definition at line 53 of file Time.h.

Member Typedef Documentation

typedef longlong Gaudi::TimeSpan::ValueType

Definition at line 56 of file Time.h.

Constructor & Destructor Documentation

Gaudi::TimeSpan::TimeSpan ( )
default

Initialize an empty (zero) time difference.

Gaudi::TimeSpan::TimeSpan ( Time  t)
inline

Initialize a time span from Time t.

Definition at line 71 of file Time.icpp.

71 : m_nsecs (t.m_nsecs) {}
ValueType m_nsecs
Definition: Time.h:109
Gaudi::TimeSpan::TimeSpan ( ValueType  nsecs)
inline

Initialize a time span to a specific length.

Definition at line 74 of file Time.icpp.

74 : m_nsecs (nsecs) {}
ValueType m_nsecs
Definition: Time.h:109
Gaudi::TimeSpan::TimeSpan ( ValueType  secs,
int  nsecs 
)
inline

Initialise a time span to a specific length.

The value is initialised to the sum of the parts—the parts do not need to fall into their "natural" ranges. The values are normalised to the natural meanings (e.g. 1000 seconds - 500 nanoseconds), so be careful with signs if you are producing values from other sources.

Parameters
secsSeconds.
nsecsNanoseconds.

Definition at line 84 of file Time.icpp.

85  : m_nsecs(secs * Time::SEC_NSECS + nsecs) {}
ValueType m_nsecs
Definition: Time.h:109
static const ValueType SEC_NSECS
Nanoseconds in one second.
Definition: Time.h:264
Gaudi::TimeSpan::TimeSpan ( int  days,
int  hours,
int  mins,
int  secs,
int  nsecs 
)
inline

Initialise a time span to a specific length.

The value is initialised to the sum of the parts—the parts do not need to fall into their "natural" ranges. The values are normalised to the natural meanings (e.g. 1000 seconds - 500 nanoseconds), so be careful with signs if you are producing values from other sources.

Parameters
daysWhole days.
hoursWhole hours.
minsWhole minutes.
secsWhole seconds.
nsecsNanoseconds.

Definition at line 98 of file Time.icpp.

98  {
99  m_nsecs = (secs + 60 * (mins + 60 * (hours + 24*days)))*Time::SEC_NSECS + nsecs;
100  }
ValueType m_nsecs
Definition: Time.h:109
static const ValueType SEC_NSECS
Nanoseconds in one second.
Definition: Time.h:264
int days() const
Get the number of complete days in the span.
Definition: Time.icpp:103
int hours() const
Get the number of complete hours in the span.
Definition: Time.icpp:108

Member Function Documentation

int Gaudi::TimeSpan::days ( ) const
inline

Get the number of complete days in the span.

Definition at line 103 of file Time.icpp.

103  {
105  }
ValueType m_nsecs
Definition: Time.h:109
static const ValueType SEC_NSECS
Nanoseconds in one second.
Definition: Time.h:264
static const int SECS_PER_DAY
Seconds in 24 hours.
Definition: Time.h:258
int Gaudi::TimeSpan::hours ( ) const
inline

Get the number of complete hours in the span.

Definition at line 108 of file Time.icpp.

108  {
110  }
static const int SECS_PER_HOUR
Seconds in one hour hour.
Definition: Time.h:261
ValueType m_nsecs
Definition: Time.h:109
static const ValueType SEC_NSECS
Nanoseconds in one second.
Definition: Time.h:264
int Gaudi::TimeSpan::lastHours ( ) const
inline

Get the number of complete hours in the last incomplete day of the span.

Definition at line 129 of file Time.icpp.

129  {
130  return hours () - days () * 24;
131  }
int days() const
Get the number of complete days in the span.
Definition: Time.icpp:103
int hours() const
Get the number of complete hours in the span.
Definition: Time.icpp:108
int Gaudi::TimeSpan::lastMinutes ( ) const
inline

Get the number of complete minutes in the last incomplete hour of the span.

Definition at line 135 of file Time.icpp.

135  {
136  return minutes () - hours () * 60;
137  }
int hours() const
Get the number of complete hours in the span.
Definition: Time.icpp:108
int minutes() const
Get the number of complete minutes in the span.
Definition: Time.icpp:113
int Gaudi::TimeSpan::lastNSeconds ( ) const
inline

Get the number of nanoseconds in the last incomplete second of the span.

Definition at line 147 of file Time.icpp.

147  {
148  return int(m_nsecs % Time::SEC_NSECS);
149  }
ValueType m_nsecs
Definition: Time.h:109
static const ValueType SEC_NSECS
Nanoseconds in one second.
Definition: Time.h:264
int Gaudi::TimeSpan::lastSeconds ( ) const
inline

Get the number of complete seconds in the last incomplete minute of the span.

Definition at line 141 of file Time.icpp.

141  {
142  return int(seconds() - ( (ValueType)minutes() * (ValueType)60 ));
143  }
longlong ValueType
Definition: Time.h:56
ValueType seconds() const
Get the number of complete seconds in the span.
Definition: Time.icpp:118
int minutes() const
Get the number of complete minutes in the span.
Definition: Time.icpp:113
int Gaudi::TimeSpan::minutes ( ) const
inline

Get the number of complete minutes in the span.

Definition at line 113 of file Time.icpp.

113  {
114  return int(m_nsecs / Time::SEC_NSECS / 60);
115  }
ValueType m_nsecs
Definition: Time.h:109
static const ValueType SEC_NSECS
Nanoseconds in one second.
Definition: Time.h:264
TimeSpan::ValueType Gaudi::TimeSpan::ns ( ) const
inline

Return the time span as nanoseconds.

Definition at line 123 of file Time.icpp.

123  {
124  return m_nsecs;
125  }
ValueType m_nsecs
Definition: Time.h:109
TimeSpan & Gaudi::TimeSpan::operator%= ( const TimeSpan x)
inline

Compute a modulo of a time span.

Definition at line 175 of file Time.icpp.

175  {
176  m_nsecs %= x.m_nsecs; return *this;
177  }
ValueType m_nsecs
Definition: Time.h:109
TimeSpan & Gaudi::TimeSpan::operator*= ( const TimeSpan x)
inline

Multiply a time span.

Definition at line 164 of file Time.icpp.

164  {
165  m_nsecs *= x.m_nsecs;
166  return *this;
167  }
ValueType m_nsecs
Definition: Time.h:109
TimeSpan & Gaudi::TimeSpan::operator+= ( const TimeSpan x)
inline

Add to a time span.

Definition at line 152 of file Time.icpp.

152  {
153  m_nsecs += x.m_nsecs;
154  return *this;
155  }
ValueType m_nsecs
Definition: Time.h:109
TimeSpan & Gaudi::TimeSpan::operator-= ( const TimeSpan x)
inline

Subtract from a time span.

Definition at line 158 of file Time.icpp.

158  {
159  m_nsecs -= x.m_nsecs;
160  return *this;
161  }
ValueType m_nsecs
Definition: Time.h:109
TimeSpan & Gaudi::TimeSpan::operator/= ( const TimeSpan x)
inline

Divide a time span.

Definition at line 170 of file Time.icpp.

170  {
171  m_nsecs /= x.m_nsecs; return *this;
172  }
ValueType m_nsecs
Definition: Time.h:109
TimeSpan::ValueType Gaudi::TimeSpan::seconds ( ) const
inline

Get the number of complete seconds in the span.

Definition at line 118 of file Time.icpp.

118  {
119  return m_nsecs / Time::SEC_NSECS;
120  }
ValueType m_nsecs
Definition: Time.h:109
static const ValueType SEC_NSECS
Nanoseconds in one second.
Definition: Time.h:264

Friends And Related Function Documentation

bool operator!= ( const Gaudi::TimeSpan t1,
const Gaudi::TimeSpan t2 
)
friend

Definition at line 87 of file Time.h.

88  { return t1.ns() != t2.ns(); }
ValueType ns() const
Return the time span as nanoseconds.
Definition: Time.icpp:123
Gaudi::TimeSpan operator+ ( const Gaudi::TimeSpan ts1,
const Gaudi::TimeSpan ts2 
)
friend

Definition at line 102 of file Time.h.

103  { return Gaudi::TimeSpan (ts1.ns() + ts2.ns()); }
ValueType ns() const
Return the time span as nanoseconds.
Definition: Time.icpp:123
Based on seal::TimeSpan.
Definition: Time.h:53
Gaudi::TimeSpan operator- ( const Gaudi::TimeSpan ts1,
const Gaudi::TimeSpan ts2 
)
friend

Definition at line 105 of file Time.h.

106  { return Gaudi::TimeSpan (ts1.ns() - ts2.ns()); }
ValueType ns() const
Return the time span as nanoseconds.
Definition: Time.icpp:123
Based on seal::TimeSpan.
Definition: Time.h:53
bool operator< ( const Gaudi::TimeSpan t1,
const Gaudi::TimeSpan t2 
)
friend

Definition at line 90 of file Time.h.

91  { return t1.ns() < t2.ns(); }
ValueType ns() const
Return the time span as nanoseconds.
Definition: Time.icpp:123
bool operator<= ( const Gaudi::TimeSpan t1,
const Gaudi::TimeSpan t2 
)
friend

Definition at line 93 of file Time.h.

94  { return t1.ns() <= t2.ns(); }
ValueType ns() const
Return the time span as nanoseconds.
Definition: Time.icpp:123
bool operator== ( const Gaudi::TimeSpan t1,
const Gaudi::TimeSpan t2 
)
friend

Definition at line 84 of file Time.h.

85  { return t1.ns() == t2.ns(); }
ValueType ns() const
Return the time span as nanoseconds.
Definition: Time.icpp:123
bool operator> ( const Gaudi::TimeSpan t1,
const Gaudi::TimeSpan t2 
)
friend

Definition at line 96 of file Time.h.

97  { return t1.ns() > t2.ns(); }
ValueType ns() const
Return the time span as nanoseconds.
Definition: Time.icpp:123
bool operator>= ( const Gaudi::TimeSpan t1,
const Gaudi::TimeSpan t2 
)
friend

Definition at line 99 of file Time.h.

100  { return t1.ns() >= t2.ns(); }
ValueType ns() const
Return the time span as nanoseconds.
Definition: Time.icpp:123
friend class Time
friend

Definition at line 54 of file Time.h.

Member Data Documentation

ValueType Gaudi::TimeSpan::m_nsecs = 0
private

Definition at line 109 of file Time.h.


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