ros::Time Class Reference
Time representation. May either represent wall clock time or ROS clock time.
More...
#include <time.h>
List of all members.
Public Member Functions |
| | Time (double t) |
| | Time (uint32_t _sec, uint32_t _nsec) |
| | Time () |
Static Public Member Functions |
| 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.
|
| 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.
|
| static void | setNow (const Time &new_now) |
| static void | shutdown () |
| static bool | sleepUntil (const Time &end) |
| | Sleep until a specific time has been reached.
|
| static bool | useSystemTime () |
| static bool | waitForValid (const ros::WallDuration &timeout) |
| | Wait for time to become valid, with timeout.
|
| static bool | waitForValid () |
| | Wait for time to become valid.
|
Detailed Description
Time representation. May either represent wall clock time or ROS clock time.
ros::TimeBase provides most of its functionality.
Definition at line 189 of file time.h.
Constructor & Destructor Documentation
| ros::Time::Time |
( |
|
) |
[inline] |
| ros::Time::Time |
( |
uint32_t |
_sec, |
|
|
uint32_t |
_nsec | |
|
) |
| | [inline] |
| ros::Time::Time |
( |
double |
t |
) |
[inline, explicit] |
Member Function Documentation
| void ros::Time::init |
( |
|
) |
[static] |
| bool ros::Time::isSimTime |
( |
|
) |
[static] |
| bool ros::Time::isSystemTime |
( |
|
) |
[static] |
| 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 272 of file 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 232 of file time.cpp.
| void ros::Time::setNow |
( |
const Time & |
new_now |
) |
[static] |
| void ros::Time::shutdown |
( |
|
) |
[static] |
| bool ros::Time::sleepUntil |
( |
const Time & |
end |
) |
[static] |
Sleep until a specific time has been reached.
Definition at line 315 of file time.cpp.
| bool ros::Time::useSystemTime |
( |
|
) |
[static] |
Wait for time to become valid, with timeout.
Definition at line 282 of file time.cpp.
| bool ros::Time::waitForValid |
( |
|
) |
[static] |
Wait for time to become valid.
Definition at line 277 of file time.cpp.
The documentation for this class was generated from the following files:
