Manages a steady-clock timer callback. More...
#include <steady_timer.h>
Classes | |
class | Impl |
Public Member Functions | |
bool | hasPending () |
Returns whether or not the timer has any pending events to call. More... | |
bool | hasStarted () const |
bool | isValid () |
operator void * () | |
bool | operator!= (const SteadyTimer &rhs) |
bool | operator< (const SteadyTimer &rhs) |
SteadyTimer & | operator= (const SteadyTimer &other)=default |
bool | operator== (const SteadyTimer &rhs) |
void | setPeriod (const WallDuration &period, bool reset=true) |
Set the period of this timer. More... | |
void | start () |
Start the timer. Does nothing if the timer is already started. More... | |
SteadyTimer () | |
SteadyTimer (const SteadyTimer &rhs) | |
void | stop () |
Stop the timer. Once this call returns, no more callbacks will be called. Does nothing if the timer is already stopped. More... | |
~SteadyTimer () | |
Private Types | |
typedef boost::shared_ptr< Impl > | ImplPtr |
typedef boost::weak_ptr< Impl > | ImplWPtr |
Private Member Functions | |
SteadyTimer (const SteadyTimerOptions &ops) | |
Private Attributes | |
ImplPtr | impl_ |
Friends | |
class | NodeHandle |
Manages a steady-clock timer callback.
A SteadyTimer should always be created through a call to NodeHandle::createSteadyTimer(), or copied from one that was. Once all copies of a specific SteadyTimer go out of scope, the callback associated with that handle will stop being called.
Definition at line 46 of file steady_timer.h.
|
private |
Definition at line 121 of file steady_timer.h.
|
private |
Definition at line 122 of file steady_timer.h.
|
inline |
Definition at line 49 of file steady_timer.h.
ros::SteadyTimer::SteadyTimer | ( | const SteadyTimer & | rhs | ) |
Definition at line 107 of file steady_timer.cpp.
ros::SteadyTimer::~SteadyTimer | ( | ) |
Definition at line 112 of file steady_timer.cpp.
|
private |
Definition at line 96 of file steady_timer.cpp.
bool ros::SteadyTimer::hasPending | ( | ) |
Returns whether or not the timer has any pending events to call.
Definition at line 132 of file steady_timer.cpp.
|
inline |
Definition at line 75 of file steady_timer.h.
|
inline |
Definition at line 76 of file steady_timer.h.
|
inline |
Definition at line 77 of file steady_timer.h.
|
inline |
Definition at line 89 of file steady_timer.h.
|
inline |
Definition at line 79 of file steady_timer.h.
|
default |
|
inline |
Definition at line 84 of file steady_timer.h.
void ros::SteadyTimer::setPeriod | ( | const WallDuration & | period, |
bool | reset = true |
||
) |
Set the period of this timer.
reset | Whether to reset the timer. If true, timer ignores elapsed time and next cb occurs at now()+period |
Definition at line 142 of file steady_timer.cpp.
void ros::SteadyTimer::start | ( | ) |
Start the timer. Does nothing if the timer is already started.
Definition at line 116 of file steady_timer.cpp.
void ros::SteadyTimer::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 124 of file steady_timer.cpp.
|
friend |
Definition at line 126 of file steady_timer.h.
|
private |
Definition at line 124 of file steady_timer.h.