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

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

#include <time.h>

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

Public Member Functions

 SteadyTime ()
 
 SteadyTime (uint32_t _sec, uint32_t _nsec)
 
 SteadyTime (double t)
 
- Public Member Functions inherited from ros::TimeBase< SteadyTime, WallDuration >
SteadyTimefromNSec (uint64_t t)
 
SteadyTimefromSec (double t)
 
bool is_zero () const
 
bool isZero () const
 
bool operator!= (const SteadyTime &rhs) const
 
SteadyTime operator+ (const WallDuration &rhs) const
 
SteadyTimeoperator+= (const WallDuration &rhs)
 
WallDuration operator- (const SteadyTime &rhs) const
 
SteadyTime operator- (const WallDuration &rhs) const
 
SteadyTimeoperator-= (const WallDuration &rhs)
 
bool operator< (const SteadyTime &rhs) const
 
bool operator<= (const SteadyTime &rhs) const
 
bool operator== (const SteadyTime &rhs) const
 
bool operator> (const SteadyTime &rhs) const
 
bool operator>= (const SteadyTime &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 SteadyTime now ()
 Returns the current steady (monotonic) clock time. More...
 
static bool sleepUntil (const SteadyTime &end)
 Sleep until a specific time has been reached. More...
 

Additional Inherited Members

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

Detailed Description

Time representation. Always steady-clock time.

Not affected by ROS time.

ros::TimeBase provides most of its functionality.

Definition at line 260 of file time.h.

Constructor & Destructor Documentation

◆ SteadyTime() [1/3]

ros::SteadyTime::SteadyTime ( )
inline

Definition at line 263 of file time.h.

◆ SteadyTime() [2/3]

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

Definition at line 267 of file time.h.

◆ SteadyTime() [3/3]

ros::SteadyTime::SteadyTime ( double  t)
inlineexplicit

Definition at line 271 of file time.h.

Member Function Documentation

◆ isSystemTime()

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

Definition at line 284 of file time.h.

◆ now()

SteadyTime ros::SteadyTime::now ( )
static

Returns the current steady (monotonic) clock time.

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

◆ sleepUntil()

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

Sleep until a specific time has been reached.

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

Definition at line 373 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