Public Member Functions | Static Public Member Functions | List of all members
ros::WallTime Class Reference

Time representation. Always wall-clock time. More...

#include <time.h>

Inheritance diagram for ros::WallTime:
Inheritance graph
[legend]

Public Member Functions

 WallTime ()
 
 WallTime (uint32_t _sec, uint32_t _nsec)
 
 WallTime (double t)
 
- Public Member Functions inherited from ros::TimeBase< WallTime, WallDuration >
WallTimefromNSec (uint64_t t)
 
WallTimefromSec (double t)
 
bool is_zero () const
 
bool isZero () const
 
bool operator!= (const WallTime &rhs) const
 
WallTime operator+ (const WallDuration &rhs) const
 
WallTimeoperator+= (const WallDuration &rhs)
 
WallDuration operator- (const WallTime &rhs) const
 
WallTime operator- (const WallDuration &rhs) const
 
WallTimeoperator-= (const WallDuration &rhs)
 
bool operator< (const WallTime &rhs) const
 
bool operator<= (const WallTime &rhs) const
 
bool operator== (const WallTime &rhs) const
 
bool operator> (const WallTime &rhs) const
 
bool operator>= (const WallTime &rhs) const
 
 TimeBase ()
 
 TimeBase (uint32_t _sec, uint32_t _nsec)
 
 TimeBase (double t)
 
boost::posix_time::ptime toBoost () const
 
uint64_t toNSec () const
 
double toSec () const
 

Static Public Member Functions

static bool isSystemTime ()
 
static WallTime now ()
 Returns the current wall clock time. More...
 
static bool sleepUntil (const WallTime &end)
 Sleep until a specific time has been reached. More...
 

Additional Inherited Members

- Public Attributes inherited from ros::TimeBase< WallTime, WallDuration >
uint32_t nsec
 
uint32_t sec
 

Detailed Description

Time representation. Always wall-clock time.

ros::TimeBase provides most of its functionality.

Definition at line 226 of file time.h.

Constructor & Destructor Documentation

◆ WallTime() [1/3]

ros::WallTime::WallTime ( )
inline

Definition at line 229 of file time.h.

◆ WallTime() [2/3]

ros::WallTime::WallTime ( uint32_t  _sec,
uint32_t  _nsec 
)
inline

Definition at line 233 of file time.h.

◆ WallTime() [3/3]

ros::WallTime::WallTime ( double  t)
inlineexplicit

Definition at line 237 of file time.h.

Member Function Documentation

◆ isSystemTime()

static bool ros::WallTime::isSystemTime ( )
inlinestatic

Definition at line 250 of file time.h.

◆ now()

WallTime ros::WallTime::now ( )
static

Returns the current wall clock time.

Definition at line 438 of file src/time.cpp.

◆ sleepUntil()

bool ros::WallTime::sleepUntil ( const WallTime end)
static

Sleep until a specific time has been reached.

Returns
True if the desired sleep time was met, false otherwise.

Definition at line 362 of file src/time.cpp.


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


rostime
Author(s): Josh Faust
autogenerated on Mon Feb 28 2022 23:31:37