The Gaudi Framework  master (37c0b60a)
Gaudi::TimeSpan Class Reference

#include <GaudiKernel/Time.h>

Public Types

typedef long long 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 62 of file Time.h.

Member Typedef Documentation

◆ ValueType

typedef long long Gaudi::TimeSpan::ValueType

Definition at line 66 of file Time.h.

Constructor & Destructor Documentation

◆ TimeSpan() [1/5]

Gaudi::TimeSpan::TimeSpan ( )
default

Initialize an empty (zero) time difference.


◆ TimeSpan() [2/5]

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

Initialize a time span from Time t.

Definition at line 72 of file Time.icpp.

72 : m_nsecs( t.m_nsecs ) {}

◆ TimeSpan() [3/5]

Gaudi::TimeSpan::TimeSpan ( ValueType  nsecs)
inline

Initialize a time span to a specific length.

Definition at line 75 of file Time.icpp.

75 : m_nsecs( nsecs ) {}

◆ TimeSpan() [4/5]

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 85 of file Time.icpp.

85 : m_nsecs( secs * Time::SEC_NSECS + nsecs ) {}

◆ TimeSpan() [5/5]

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  }

Member Function Documentation

◆ days()

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

Get the number of complete days in the span.


Definition at line 103 of file Time.icpp.

103 { return int( m_nsecs / Time::SEC_NSECS / Time::SECS_PER_DAY ); }

◆ hours()

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

Get the number of complete hours in the span.


Definition at line 106 of file Time.icpp.

106 { return int( m_nsecs / Time::SEC_NSECS / Time::SECS_PER_HOUR ); }

◆ lastHours()

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

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


Definition at line 119 of file Time.icpp.

119 { return hours() - days() * 24; }

◆ lastMinutes()

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

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


Definition at line 123 of file Time.icpp.

123 { return minutes() - hours() * 60; }

◆ lastNSeconds()

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

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

Definition at line 131 of file Time.icpp.

131 { return int( m_nsecs % Time::SEC_NSECS ); }

◆ lastSeconds()

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

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

Definition at line 127 of file Time.icpp.

127 { return int( seconds() - ( (ValueType)minutes() * (ValueType)60 ) ); }

◆ minutes()

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

Get the number of complete minutes in the span.


Definition at line 109 of file Time.icpp.

109 { return int( m_nsecs / Time::SEC_NSECS / 60 ); }

◆ ns()

TimeSpan::ValueType Gaudi::TimeSpan::ns ( ) const
inline

Return the time span as nanoseconds.


Definition at line 115 of file Time.icpp.

115 { return m_nsecs; }

◆ operator%=()

TimeSpan & Gaudi::TimeSpan::operator%= ( const TimeSpan x)
inline

Compute a modulo of a time span.


Definition at line 158 of file Time.icpp.

158  {
159  m_nsecs %= x.m_nsecs;
160  return *this;
161  }

◆ operator*=()

TimeSpan & Gaudi::TimeSpan::operator*= ( const TimeSpan x)
inline

Multiply a time span.


Definition at line 146 of file Time.icpp.

146  {
147  m_nsecs *= x.m_nsecs;
148  return *this;
149  }

◆ operator+=()

TimeSpan & Gaudi::TimeSpan::operator+= ( const TimeSpan x)
inline

Add to a time span.


Definition at line 134 of file Time.icpp.

134  {
135  m_nsecs += x.m_nsecs;
136  return *this;
137  }

◆ operator-=()

TimeSpan & Gaudi::TimeSpan::operator-= ( const TimeSpan x)
inline

Subtract from a time span.


Definition at line 140 of file Time.icpp.

140  {
141  m_nsecs -= x.m_nsecs;
142  return *this;
143  }

◆ operator/=()

TimeSpan & Gaudi::TimeSpan::operator/= ( const TimeSpan x)
inline

Divide a time span.


Definition at line 152 of file Time.icpp.

152  {
153  m_nsecs /= x.m_nsecs;
154  return *this;
155  }

◆ seconds()

TimeSpan::ValueType Gaudi::TimeSpan::seconds ( ) const
inline

Get the number of complete seconds in the span.


Definition at line 112 of file Time.icpp.

112 { return m_nsecs / Time::SEC_NSECS; }

Friends And Related Function Documentation

◆ operator!=

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

Definition at line 96 of file Time.h.

96 { return t1.ns() != t2.ns(); }

◆ operator+

Gaudi::TimeSpan operator+ ( const Gaudi::TimeSpan ts1,
const Gaudi::TimeSpan ts2 
)
friend

Definition at line 106 of file Time.h.

106  {
107  return Gaudi::TimeSpan( ts1.ns() + ts2.ns() );
108  }

◆ operator-

Gaudi::TimeSpan operator- ( const Gaudi::TimeSpan ts1,
const Gaudi::TimeSpan ts2 
)
friend

Definition at line 110 of file Time.h.

110  {
111  return Gaudi::TimeSpan( ts1.ns() - ts2.ns() );
112  }

◆ operator<

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

Definition at line 98 of file Time.h.

98 { return t1.ns() < t2.ns(); }

◆ operator<=

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

Definition at line 100 of file Time.h.

100 { return t1.ns() <= t2.ns(); }

◆ operator==

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

Definition at line 94 of file Time.h.

94 { return t1.ns() == t2.ns(); }

◆ operator>

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

Definition at line 102 of file Time.h.

102 { return t1.ns() > t2.ns(); }

◆ operator>=

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

Definition at line 104 of file Time.h.

104 { return t1.ns() >= t2.ns(); }

◆ Time

friend class Time
friend

Definition at line 63 of file Time.h.

Member Data Documentation

◆ m_nsecs

ValueType Gaudi::TimeSpan::m_nsecs = 0
private

Definition at line 115 of file Time.h.


The documentation for this class was generated from the following files:
Gaudi::TimeSpan::minutes
int minutes() const
Get the number of complete minutes in the span.
Definition: Time.icpp:109
Gaudi::TimeSpan::seconds
ValueType seconds() const
Get the number of complete seconds in the span.
Definition: Time.icpp:112
Gaudi::TimeSpan::ValueType
long long ValueType
Definition: Time.h:66
Gaudi::Time::SECS_PER_DAY
static const int SECS_PER_DAY
Seconds in 24 hours.
Definition: Time.h:264
Gaudi::TimeSpan::m_nsecs
ValueType m_nsecs
Definition: Time.h:115
Gaudi::TimeSpan::ns
ValueType ns() const
Return the time span as nanoseconds.
Definition: Time.icpp:115
Gaudi::TimeSpan
Definition: Time.h:62
bug_34121.t
t
Definition: bug_34121.py:31
TemplatedAlg
Definition: TemplatedAlg.cpp:22
Gaudi::TimeSpan::days
int days() const
Get the number of complete days in the span.
Definition: Time.icpp:103
Gaudi::Time::SEC_NSECS
static const ValueType SEC_NSECS
Nanoseconds in one second.
Definition: Time.h:270
Gaudi::TimeSpan::hours
int hours() const
Get the number of complete hours in the span.
Definition: Time.icpp:106
Gaudi::Time::SECS_PER_HOUR
static const int SECS_PER_HOUR
Seconds in one hour hour.
Definition: Time.h:267