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

Time representation. May either represent wall clock time or ROS clock time. More...

#include <time.h>

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

Public Member Functions

 Time ()
 
 Time (uint32_t _sec, uint32_t _nsec)
 
 Time (double t)
 
- Public Member Functions inherited from ros::TimeBase< Time, Duration >
TimefromNSec (uint64_t t)
 
TimefromSec (double t)
 
bool is_zero () const
 
bool isZero () const
 
bool operator!= (const Time &rhs) const
 
Time operator+ (const Duration &rhs) const
 
Timeoperator+= (const Duration &rhs)
 
Duration operator- (const Time &rhs) const
 
Time operator- (const Duration &rhs) const
 
Timeoperator-= (const Duration &rhs)
 
bool operator< (const Time &rhs) const
 
bool operator<= (const Time &rhs) const
 
bool operator== (const Time &rhs) const
 
bool operator> (const Time &rhs) const
 
bool operator>= (const Time &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
 
 ~TimeBase ()
 

Static Public Member Functions

static Time fromBoost (const boost::posix_time::ptime &t)
 
static Time fromBoost (const boost::posix_time::time_duration &d)
 
static void init ()
 
static bool isSimTime ()
 
static bool isSystemTime ()
 
static bool isValid ()
 Returns whether or not the current time is valid. Time is valid if it is non-zero. More...
 
static Time now ()
 Retrieve the current time. If ROS clock time is in use, this returns the time according to the ROS clock. Otherwise returns the current wall clock time. More...
 
static void setNow (const Time &new_now)
 
static void shutdown ()
 
static bool sleepUntil (const Time &end)
 Sleep until a specific time has been reached. More...
 
static bool useSystemTime ()
 
static bool waitForValid ()
 Wait for time to become valid. More...
 
static bool waitForValid (const ros::WallDuration &timeout)
 Wait for time to become valid, with timeout. More...
 

Additional Inherited Members

- Public Attributes inherited from ros::TimeBase< Time, Duration >
uint32_t nsec
 
uint32_t sec
 

Detailed Description

Time representation. May either represent wall clock time or ROS clock time.

ros::TimeBase provides most of its functionality.

Definition at line 181 of file time.h.

Constructor & Destructor Documentation

ros::Time::Time ( )
inline

Definition at line 184 of file time.h.

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

Definition at line 188 of file time.h.

ros::Time::Time ( double  t)
inlineexplicit

Definition at line 192 of file time.h.

Member Function Documentation

Time ros::Time::fromBoost ( const boost::posix_time::ptime &  t)
static

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

Time ros::Time::fromBoost ( const boost::posix_time::time_duration &  d)
static

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

void ros::Time::init ( )
static

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

bool ros::Time::isSimTime ( )
static

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

bool ros::Time::isSystemTime ( )
static

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

bool ros::Time::isValid ( )
static

Returns whether or not the current time is valid. Time is valid if it is non-zero.

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

Time ros::Time::now ( )
static

Retrieve the current time. If ROS clock time is in use, this returns the time according to the ROS clock. Otherwise returns the current wall clock time.

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

void ros::Time::setNow ( const Time new_now)
static

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

void ros::Time::shutdown ( )
static

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

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

Sleep until a specific time has been reached.

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

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

bool ros::Time::useSystemTime ( )
static

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

bool ros::Time::waitForValid ( )
static

Wait for time to become valid.

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

bool ros::Time::waitForValid ( const ros::WallDuration timeout)
static

Wait for time to become valid, with timeout.

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


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


rostime
Author(s): Josh Faust
autogenerated on Tue Apr 3 2018 02:26:56