ros::Timer Class Reference
Manages a timer callback.
More...
#include <timer.h>
List of all members.
Detailed Description
Manages a timer callback.
A Timer should always be created through a call to NodeHandle::createTimer(), or copied from one that was. Once all copies of a specific Timer go out of scope, the callback associated with that handle will stop being called.
Definition at line 45 of file timer.h.
Member Typedef Documentation
Constructor & Destructor Documentation
| ros::Timer::Timer |
( |
|
) |
[inline] |
| ros::Timer::Timer |
( |
const Timer & |
rhs |
) |
|
Member Function Documentation
| bool ros::Timer::hasPending |
( |
|
) |
|
Returns whether or not the timer has any pending events to call.
Definition at line 130 of file timer.cpp.
| bool ros::Timer::isValid |
( |
|
) |
[inline] |
| ros::Timer::operator void * |
( |
|
) |
[inline] |
| bool ros::Timer::operator!= |
( |
const Timer & |
rhs |
) |
[inline] |
| bool ros::Timer::operator< |
( |
const Timer & |
rhs |
) |
[inline] |
| bool ros::Timer::operator== |
( |
const Timer & |
rhs |
) |
[inline] |
| void ros::Timer::setPeriod |
( |
const Duration & |
period |
) |
|
Set the period of this timer.
Definition at line 140 of file timer.cpp.
| void ros::Timer::start |
( |
|
) |
|
Start the timer. Does nothing if the timer is already started.
Definition at line 114 of file timer.cpp.
| void ros::Timer::stop |
( |
|
) |
|
Stop the timer. Once this call returns, no more callbacks will be called. Does nothing if the timer is already stopped.
Definition at line 122 of file timer.cpp.
Friends And Related Function Documentation
Member Data Documentation
The documentation for this class was generated from the following files:
