rnr::chronos::Time Class Reference

Time class. More...

#include <Time.h>

Public Member Functions
	Time ()
	Default constructor.
	Time (const timespec &ts)
	Initialization constructor. More...
	Time (const double &t)
	Initialization constructor. More...
	Time (const Time &src)
	Copy constructor. More...
	~Time ()
	Destructor.
double	t ()
	Get this object's value as a floating point number of seconds and fractions of a second. More...
timespec	ts ()
	Get this object's value in timespec format. More...
bool	isSet ()
	Check if this object's time is set. More...
void	clear ()
	Clear this object's time.
double	getResolution ()
	Get the CLOCK_REALTIME resolution. More...
double	now ()
	Get the current time, indentified by CLOCK_REALTIME, since the last Epoch. More...
double	markNow ()
	Mark the current time, indentified by CLOCK_REALTIME, since the last Epoch. More...
Time &	operator= (const Time &b)
	this = b More...
Time &	operator= (const timespec &b)
	this = b More...
Time &	operator= (const double &b)
	this = b More...
Time &	operator+= (const Time &b)
	this += b More...
Time &	operator+= (const timespec &b)
	this += b More...
Time &	operator+= (const double &b)
	this += b More...
Time &	operator-= (const Time &b)
	this -= b More...
Time &	operator-= (const timespec &b)
	this -= b More...
Time &	operator-= (const double &b)
	this -= b More...
Time &	operator*= (const double &b)
	this *= b More...
bool	operator== (const Time &b)
	this == b More...
bool	operator== (const timespec &b)
	this == b More...
bool	operator== (const double &b)
	this == b More...
bool	operator< (const Time &b)
	this < b More...
bool	operator< (const timespec &b)
	this < b More...
bool	operator< (const double &b)
	this < b More...
bool	operator> (const Time &b)
	this > b More...
bool	operator> (const timespec &b)
	this > b More...
bool	operator> (const double &b)
	this > b More...
bool	operator<= (const Time &b)
	this <= b More...
bool	operator<= (const timespec &b)
	this <= b More...
bool	operator<= (const double &b)
	this <= b More...
bool	operator>= (const Time &b)
	this >= b More...
bool	operator>= (const timespec &b)
	this >= b More...
bool	operator>= (const double &b)
	this >= b More...
std::string	calendarTime (const int resSec=0) const

Protected Attributes
timespec	m_tsTime
	time in timespec format
double	m_fpTime
	time in floating point format

Friends
Time	operator+ (Time a, const Time &b)
	c = a + b More...
Time	operator+ (Time a, const timespec &b)
	c = a + b More...
Time	operator+ (Time a, const double &b)
	c = a + b More...
Time	operator- (Time a, const Time &b)
	c = a - b More...
Time	operator- (Time a, const timespec &b)
	c = a - b More...
Time	operator- (Time a, const double &b)
	c = a - b More...
Time	operator* (Time a, const double &b)
	c = a * b More...
std::ostream &	operator<< (std::ostream &os, const Time &obj)
	Time insertion operator. More...

Detailed Description

Time class.

The class uses timespec as the underlining interface to system calls. Some calls require the lower resolution timeval interface. This class will autobmaitcally down/up samples between the two interfaces

Definition at line 192 of file Time.h.

Constructor & Destructor Documentation

Time::Time

(

const timespec &

ts

)

Initialization constructor.

Parameters

ts	Time in timespec format.

Definition at line 167 of file Time.cxx.

References rnr::chronos::toFp().

{
  m_tsTime  = ts;
  m_fpTime  = chronos::toFp(m_tsTime);
}

Time::Time

(

const double &

t

)

Initialization constructor.

Parameters

t

Seconds.

Definition at line 173 of file Time.cxx.

References rnr::chronos::toTs().

{
  m_fpTime  = t;
  m_tsTime  = chronos::toTs(m_fpTime);
}

Time::Time

(

const Time &

src

)

Copy constructor.

Parameters

src	Source object.

Definition at line 179 of file Time.cxx.

References m_fpTime, and m_tsTime.

{
  m_tsTime = src.m_tsTime;
  m_fpTime = src.m_fpTime;
}

Member Function Documentation

double Time::getResolution

(

)

Get the CLOCK_REALTIME resolution.

Returns

Returns a floating point number of the resolution in seconds and fractions of a second.

Definition at line 196 of file Time.cxx.

References rnr::chronos::clear(), and rnr::chronos::toFp().

Referenced by isSet().

{
  timespec res;

  if( clock_getres(CLOCK_REALTIME, &res) < 0 )
  {
    chronos::clear(res);
  }

  return chronos::toFp(res);
}

bool rnr::chronos::Time::isSet ( )

inline

Check if this object's time is set.

Returns

Returns true or false.

Definition at line 254 of file Time.h.

References clear(), getResolution(), rnr::chronos::isSet(), m_tsTime, markNow(), now(), operator*=(), operator+=(), operator-=(), and operator=().

      {
        return chronos::isSet(m_tsTime);
      }

double Time::markNow

(

)

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

The internal time data are automatically updated.

Returns

Returns a floating point number of the current time in seconds and fractions of a second.

Definition at line 215 of file Time.cxx.

References rnr::chronos::now(), and rnr::chronos::toFp().

Referenced by isSet(), rnr::Thread::schedBlock(), and rnr::Thread::thread().

{
  chronos::now(m_tsTime);
  m_fpTime = chronos::toFp(m_tsTime);
  return m_fpTime;
}

double Time::now

(

)

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

No internal time data are touched.

Returns

Returns a floating point number of the current time in seconds and fractions of a second.

Definition at line 208 of file Time.cxx.

References rnr::chronos::now(), and rnr::chronos::toFp().

Referenced by execFeedAnimal(), execSleep(), execWalkAnimal(), isSet(), and updateAnimals().

{
  timespec  ts = chronos::now();

  return chronos::toFp(ts);
}

Time & Time::operator*=

(

const double &

b

)

this *= b

Parameters

b	Rvalue object.

Returns

Reference to this.

Definition at line 290 of file Time.cxx.

References rnr::chronos::toTs().

Referenced by isSet().

{
  m_fpTime *= b;
  m_tsTime  = chronos::toTs(m_fpTime);
  return *this;
}

Time & Time::operator+=

(

const Time &

b

)

this += b

Parameters

b	Rvalue object.

Returns

Reference to this.

Definition at line 248 of file Time.cxx.

References rnr::chronos::add(), m_tsTime, and rnr::chronos::toFp().

Referenced by isSet().

{
  m_tsTime = chronos::add(m_tsTime, b.m_tsTime);
  m_fpTime = chronos::toFp(m_tsTime);
  return *this;
}

Time & Time::operator+=

(

const timespec &

b

)

this += b

Parameters

b	Rvalue object.

Returns

Reference to this.

Definition at line 255 of file Time.cxx.

References rnr::chronos::add(), and rnr::chronos::toFp().

{
  m_tsTime = chronos::add(m_tsTime, b);
  m_fpTime = chronos::toFp(m_tsTime);
  return *this;
}

Time & Time::operator+=

(

const double &

b

)

this += b

Parameters

b	Rvalue object.

Returns

Reference to this.

Definition at line 262 of file Time.cxx.

References rnr::chronos::toTs().

{
  m_fpTime += b;
  m_tsTime  = toTs(m_fpTime);
  return *this;
}

Time & Time::operator-=

(

const Time &

b

)

this -= b

Parameters

b	Rvalue object.

Returns

Reference to this.

Definition at line 269 of file Time.cxx.

References m_tsTime, rnr::chronos::sub(), and rnr::chronos::toFp().

Referenced by isSet().

{
  m_tsTime = chronos::sub(m_tsTime, b.m_tsTime);
  m_fpTime = chronos::toFp(m_tsTime);
  return *this;
}

Time & Time::operator-=

(

const timespec &

b

)

this -= b

Parameters

b	Rvalue object.

Returns

Reference to this.

Definition at line 276 of file Time.cxx.

References rnr::chronos::sub(), and rnr::chronos::toFp().

{
  m_tsTime = chronos::sub(m_tsTime, b);
  m_fpTime = chronos::toFp(m_tsTime);
  return *this;
}

Time & Time::operator-=

(

const double &

b

)

this -= b

Parameters

b	Rvalue object.

Returns

Reference to this.

Definition at line 283 of file Time.cxx.

References rnr::chronos::toTs().

{
  m_fpTime -= b;
  m_tsTime  = chronos::toTs(m_fpTime);
  return *this;
}

bool rnr::chronos::Time::operator< ( const Time &  b )

inline

this < b

Parameters

b	Rvalue object.

Returns

Returns true if this object is an earlier time than b. Otherwise returns false.

Definition at line 495 of file Time.h.

References m_tsTime.

Referenced by operator<=().

      {
        return operator<(b.m_tsTime);
      }

bool Time::operator<

(

const timespec &

b

)

this < b

Parameters

b	Rvalue object.

Returns

Returns true if this object is an earlier time than b. Otherwise returns false.

Definition at line 307 of file Time.cxx.

{
  if( m_tsTime.tv_sec < b.tv_sec )
  {
    return true;
  }
  else if( (m_tsTime.tv_sec == b.tv_sec) && (m_tsTime.tv_nsec < b.tv_nsec) )
  {
    return true;
  }
  else
  {
    return false;
  }
}

bool rnr::chronos::Time::operator< ( const double &  b )

inline

this < b

Parameters

b	Rvalue object.

Returns

Returns true if this object is an earlier time than b. Otherwise returns false.

Definition at line 504 of file Time.h.

References m_fpTime.

      {
        return m_fpTime < b;
      }

bool rnr::chronos::Time::operator<= ( const Time &  b )

inline

this <= b

Parameters

b	Rvalue object.

Returns

Returns true if this object is an earlier or equal time to b. Otherwise returns false.

Definition at line 549 of file Time.h.

References m_tsTime, operator<(), and operator==().

      {
        return operator<(b.m_tsTime) || operator==(b.m_tsTime);
      }

bool rnr::chronos::Time::operator<= ( const timespec &  b )

inline

this <= b

Parameters

b	Rvalue object.

Returns

Returns true if this object is an earlier or equal time to b. Otherwise returns false.

Definition at line 555 of file Time.h.

References operator<(), and operator==().

      {
        return operator<(b) || operator==(b);
      }

bool rnr::chronos::Time::operator<= ( const double &  b )

inline

this <= b

Parameters

b	Rvalue object.

Returns

Returns true if this object is an earlier or equal time to b. Otherwise returns false.

Definition at line 561 of file Time.h.

References m_fpTime.

      {
        return m_fpTime <= b;
      }

Time & Time::operator=

(

const Time &

b

)

this = b

Parameters

b	Rvalue object.

Returns

Reference to this.

Definition at line 227 of file Time.cxx.

References m_fpTime, and m_tsTime.

Referenced by isSet().

{
  m_tsTime = b.m_tsTime;
  m_fpTime = b.m_fpTime;
  return *this;
}

Time & Time::operator=

(

const timespec &

b

)

this = b

Parameters

b	Rvalue object.

Returns

Reference to this.

Definition at line 234 of file Time.cxx.

References rnr::chronos::toFp().

{
  m_tsTime = b;
  m_fpTime = chronos::toFp(m_tsTime);
  return *this;
}

Time & Time::operator=

(

const double &

b

)

this = b

Parameters

b	Rvalue object.

Returns

Reference to this.

Definition at line 241 of file Time.cxx.

References rnr::chronos::toTs().

{
  m_fpTime = b;
  m_tsTime = chronos::toTs(m_fpTime);
  return *this;
}

bool rnr::chronos::Time::operator== ( const Time &  b )

inline

this == b

Parameters

b	Rvalue object.

Returns

Returns true if this object is the same time as b. Otherwise returns false.

Definition at line 464 of file Time.h.

References m_tsTime.

Referenced by operator<=(), and operator>=().

      {
        return operator==(b.m_tsTime);
      }

bool rnr::chronos::Time::operator== ( const timespec &  b )

inline

this == b

Parameters

b	Rvalue object.

Returns

Returns true if this object is the same time as b. Otherwise returns false.

Definition at line 470 of file Time.h.

References m_tsTime.

      {
        return  (m_tsTime.tv_sec == b.tv_sec) &&
                (m_tsTime.tv_nsec == b.tv_nsec);
      }

bool rnr::chronos::Time::operator== ( const double &  b )

inline

this == b

Parameters

b	Rvalue object.

Returns

Returns true if this object is the same time as b. Otherwise returns false.

Definition at line 477 of file Time.h.

References m_fpTime.

      {
        return m_fpTime == b;
      }

bool rnr::chronos::Time::operator> ( const Time &  b )

inline

this > b

Parameters

b	Rvalue object.

Returns

Returns true if this object is an later time than b. Otherwise returns false.

Definition at line 522 of file Time.h.

References m_tsTime.

Referenced by operator>=().

      {
        return operator>(b.m_tsTime);
      }

bool Time::operator>

(

const timespec &

b

)

this > b

Parameters

b	Rvalue object.

Returns

Returns true if this object is an later time than b. Otherwise returns false.

Definition at line 323 of file Time.cxx.

References m_tsTime, rnr::chronos::operator<<(), and rnr::str::rtrim().

{
  if( m_tsTime.tv_sec > b.tv_sec )
  {
    return true;
  }
  else if( (m_tsTime.tv_sec == b.tv_sec) && (m_tsTime.tv_nsec > b.tv_nsec) )
  {
    return true;
  }
  else
  {
    return false;
  }
}

bool rnr::chronos::Time::operator> ( const double &  b )

inline

this > b

Parameters

b	Rvalue object.

Returns

Returns true if this object is an later time than b. Otherwise returns false.

Definition at line 531 of file Time.h.

References m_fpTime.

      {
        return m_fpTime > b;
      }

bool rnr::chronos::Time::operator>= ( const Time &  b )

inline

this >= b

Parameters

b	Rvalue object.

Returns

Returns true if this object is an later or equal time to b. Otherwise returns false.

Definition at line 579 of file Time.h.

References m_tsTime, operator==(), and operator>().

      {
        return operator>(b.m_tsTime) || operator==(b.m_tsTime);
      }

bool rnr::chronos::Time::operator>= ( const timespec &  b )

inline

this >= b

Parameters

b	Rvalue object.

Returns

Returns true if this object is an later or equal time to b. Otherwise returns false.

Definition at line 585 of file Time.h.

References operator==(), and operator>().

      {
        return operator>(b) || operator==(b);
      }

bool rnr::chronos::Time::operator>= ( const double &  b )

inline

this >= b

Parameters

b	Rvalue object.

Returns

Returns true if this object is an later or equal time to b. Otherwise returns false.

Definition at line 591 of file Time.h.

References m_fpTime, and operator<<.

      {
        return m_fpTime >= b;
      }

double rnr::chronos::Time::t ( )

inline

Get this object's value as a floating point number of seconds and fractions of a second.

Returns

Double.

Definition at line 234 of file Time.h.

References m_fpTime.

      {
        return m_fpTime;
      }

timespec rnr::chronos::Time::ts ( )

inline

Get this object's value in timespec format.

Returns

timespec.

Definition at line 244 of file Time.h.

References m_tsTime.

Referenced by rnr::Thread::exec(), and rnr::Thread::schedBlock().

      {
        return m_tsTime;
      }

Friends And Related Function Documentation

Time operator* ( Time  a, const double &  b  )

friend

c = a * b

Parameters

a	Time object.
b	Rvalue object.

Returns

Time

Definition at line 441 of file Time.h.

      {
        return a *= b;
      }

Time operator+ ( Time  a, const Time &  b  )

friend

c = a + b

Parameters

a	Time object.
b	Rvalue object.

Returns

Time

Definition at line 387 of file Time.h.

      {
        return a += b;
      }

Time operator+ ( Time  a, const timespec &  b  )

friend

c = a + b

Parameters

a	Time object.
b	Rvalue object.

Returns

Time

Definition at line 393 of file Time.h.

      {
        return a += b;
      }

Time operator+ ( Time  a, const double &  b  )

friend

c = a + b

Parameters

a	Time object.
b	Rvalue object.

Returns

Time

Definition at line 399 of file Time.h.

      {
        return a += b;
      }

Time operator- ( Time  a, const Time &  b  )

friend

c = a - b

Parameters

a	Time object.
b	Rvalue object.

Returns

Time

Definition at line 416 of file Time.h.

      {
        return a -= b;
      }

Time operator- ( Time  a, const timespec &  b  )

friend

c = a - b

Parameters

a	Time object.
b	Rvalue object.

Returns

Time

Definition at line 422 of file Time.h.

      {
        return a -= b;
      }

Time operator- ( Time  a, const double &  b  )

friend

c = a - b

Parameters

a	Time object.
b	Rvalue object.

Returns

Time

Definition at line 428 of file Time.h.

      {
        return a -= b;
      }

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

friend

Time insertion operator.

Parameters

os	Output stream.
obj	Object to insert.

Returns

Reference to output stream.

Referenced by operator>=().

---

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

• include/rnr/appkit/Time.h
• sw/librnr_appkit/Time.cxx