rnr::chronos Namespace Reference

Chronos - God of Time. More...

Classes
class	Time
	Time class. More...

Functions
timespec	now ()
	Get the current time, indentified by CLOCK_REALTIME, since the last Epoch. More...
int	now (timespec &ts)
	Get the current time, indentified by CLOCK_REALTIME, since the last Epoch. More...
double	toFp (const timespec &ts)
	Convert timespec to floating point number equivalent. More...
timespec	toTs (const double &t)
	Convert floating point seconds to timespec equivalent. More...
bool	isSet (const timespec &a)
	Check if timespec is set. More...
void	clear (timespec &ts)
	Clear this object's time. More...
timespec	add (const timespec &a, const timespec &b)
	Add two timespecs. More...
timespec	operator+ (const timespec &a, const timespec &b)
	a + b More...
timespec	sub (const timespec &a, const timespec &b)
	Subtract two timespecs. More...
timespec	operator- (const timespec &a, const timespec &b)
	a - b More...
timespec	normalize (const timespec &a)
	Normalize the timespec. More...
std::ostream &	operator<< (std::ostream &os, const Time &obj)
	Time insertion operator. More...

Variables
const long	MILLION = 1000000
	1,000,000
const long long	BILLION = 1000000000
	1,000,000,000

Detailed Description

Chronos - God of Time.

Function Documentation

timespec rnr::chronos::add	(	const timespec &	a,
		const timespec &	b
	)

Add two timespecs.

a + b.

Parameters

a	Timespec a.
b	Timespec b.

Returns

Normalized timespec.

Definition at line 116 of file Time.cxx.

References normalize().

Referenced by operator+(), and rnr::chronos::Time::operator+=().

    {
      timespec  ts;
    
      ts.tv_sec  = a.tv_sec  + b.tv_sec;
      ts.tv_nsec = a.tv_nsec + b.tv_nsec;
    
      return rnr::chronos::normalize(ts);
    }

void rnr::chronos::clear

(

timespec &

ts

)

Clear this object's time.

Parameters

ts

Timespec.

Definition at line 110 of file Time.cxx.

Referenced by rnr::chronos::Time::clear(), rnr::chronos::Time::getResolution(), now(), and rnr::chronos::Time::Time().

    {
      ts.tv_sec   = 0;
      ts.tv_nsec  = 0;
    }

bool rnr::chronos::isSet

(

const timespec &

a

)

Check if timespec is set.

Parameters

ts

Timespec.

Returns

Returns true or false.

Definition at line 105 of file Time.cxx.

Referenced by rnr::LogBook::Entry::empty(), and rnr::chronos::Time::isSet().

    {
      return (ts.tv_sec != 0) || (ts.tv_nsec != 0);
    }

timespec rnr::chronos::normalize

(

const timespec &

a

)

Normalize the timespec.

Parameters

a

Timespec.

Returns

Normalized timespec where tv_nsec has a value in the range 0 to 999,999,999.

Definition at line 136 of file Time.cxx.

References BILLION.

Referenced by add(), operator-(), and sub().

    {
      timespec    ts = a;
    
      while( ts.tv_nsec >= BILLION )
      {
        ts.tv_sec += 1;
        ts.tv_nsec -= BILLION;
      }
    
      while( ts.tv_nsec < 0 )
      {
        ts.tv_sec -= 1;
        ts.tv_nsec += BILLION;
      }
    
      return ts;
    }

timespec rnr::chronos::now

(

)

Get the current time, indentified by CLOCK_REALTIME, since the last Epoch.

Returns

Timespec.

Definition at line 70 of file Time.cxx.

References clear().

Referenced by rnr::LogBook::Entry::Entry(), rnr::chronos::Time::markNow(), and rnr::chronos::Time::now().

    {
      timespec  ts;
    
      if( now(ts) != OK )
      {
        clear(ts);
      }
      return ts;
    }

int rnr::chronos::now

(

timespec &

ts

)

Get the current time, indentified by CLOCK_REALTIME, since the last Epoch.

Parameters

[out]

ts

Timespec.

Returns

On success, OK(0) is returned.
On error, RC_ERROR(-1) is returned.

Definition at line 81 of file Time.cxx.

    {
      return clock_gettime(CLOCK_REALTIME, &ts) == 0? OK: RC_ERROR;
    }

timespec rnr::chronos::operator+ ( const timespec &  a, const timespec &  b  )

inline

a + b

Parameters

a	Timespec a.
b	Timespec b.

Returns

Normalized timespec.

Definition at line 140 of file Time.h.

References add(), and sub().

    {
      return add(a, b);
    }

timespec rnr::chronos::operator- ( const timespec &  a, const timespec &  b  )

inline

a - b

Parameters

a	Timespec a.
b	Timespec b.

Returns

Normalized timespec.

Definition at line 165 of file Time.h.

References normalize(), and sub().

    {
      return sub(a, b);
    }

std::ostream& rnr::chronos::operator<<	(	std::ostream &	os,
		const Time &	obj
	)

Time insertion operator.

Parameters

os	Output stream.
obj	Object to insert.

Returns

Reference to output stream.

Referenced by rnr::chronos::Time::operator>().

timespec rnr::chronos::sub	(	const timespec &	a,
		const timespec &	b
	)

Subtract two timespecs.

a - b

Parameters

a	Timespec a.
b	Timespec b.

Returns

Normalized timespec.

Definition at line 126 of file Time.cxx.

References normalize().

Referenced by operator+(), operator-(), and rnr::chronos::Time::operator-=().

    {
      timespec  ts;
    
      ts.tv_sec  = a.tv_sec  - b.tv_sec;
      ts.tv_nsec = a.tv_nsec - b.tv_nsec;
    
      return rnr::chronos::normalize(ts);
    }

double rnr::chronos::toFp

(

const timespec &

ts

)

Convert timespec to floating point number equivalent.

Parameters

ts

Timespec.

Returns

Seconds and fractions of a second.

Definition at line 86 of file Time.cxx.

References BILLION.

Referenced by rnr::chronos::Time::getResolution(), rnr::chronos::Time::markNow(), rnr::chronos::Time::now(), rnr::chronos::Time::operator+=(), rnr::chronos::Time::operator-=(), rnr::chronos::Time::operator=(), and rnr::chronos::Time::Time().

    {
      return (double)ts.tv_sec + (double)ts.tv_nsec/ (double)BILLION;
    }

timespec rnr::chronos::toTs

(

const double &

t

)

Convert floating point seconds to timespec equivalent.

Parameters

Seconds

and fractions of a second.

Returns

ts Timespec.

Definition at line 91 of file Time.cxx.

References BILLION.

Referenced by rnr::chronos::Time::operator*=(), rnr::chronos::Time::operator+=(), rnr::chronos::Time::operator-=(), rnr::chronos::Time::operator=(), and rnr::chronos::Time::Time().

    {
      timespec  ts;
      double    sec, nsec;
    
      sec  = floor(t); 
      nsec = (t - sec) * (double)BILLION;
    
      ts.tv_sec  = (long)sec;
      ts.tv_nsec = (long)nsec;
    
      return ts;
    }