Classes | Public Member Functions | Private Types | Private Member Functions | Private Attributes | Friends | List of all members
ros::WallTimer Class Reference

Manages a wall-clock timer callback. More...

#include <wall_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 WallTimer &rhs)
 
bool operator< (const WallTimer &rhs)
 
bool operator== (const WallTimer &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...
 
void stop ()
 Stop the timer. Once this call returns, no more callbacks will be called. Does nothing if the timer is already stopped. More...
 
 WallTimer ()
 
 WallTimer (const WallTimer &rhs)
 
 ~WallTimer ()
 

Private Types

typedef boost::shared_ptr< ImplImplPtr
 
typedef boost::weak_ptr< ImplImplWPtr
 

Private Member Functions

 WallTimer (const WallTimerOptions &ops)
 

Private Attributes

ImplPtr impl_
 

Friends

class NodeHandle
 

Detailed Description

Manages a wall-clock timer callback.

A WallTimer should always be created through a call to NodeHandle::createWallTimer(), or copied from one that was. Once all copies of a specific WallTimer go out of scope, the callback associated with that handle will stop being called.

Definition at line 46 of file wall_timer.h.

Member Typedef Documentation

◆ ImplPtr

Definition at line 120 of file wall_timer.h.

◆ ImplWPtr

typedef boost::weak_ptr<Impl> ros::WallTimer::ImplWPtr
private

Definition at line 121 of file wall_timer.h.

Constructor & Destructor Documentation

◆ WallTimer() [1/3]

ros::WallTimer::WallTimer ( )
inline

Definition at line 49 of file wall_timer.h.

◆ WallTimer() [2/3]

ros::WallTimer::WallTimer ( const WallTimer rhs)

Definition at line 107 of file wall_timer.cpp.

◆ ~WallTimer()

ros::WallTimer::~WallTimer ( )

Definition at line 112 of file wall_timer.cpp.

◆ WallTimer() [3/3]

ros::WallTimer::WallTimer ( const WallTimerOptions ops)
private

Definition at line 96 of file wall_timer.cpp.

Member Function Documentation

◆ hasPending()

bool ros::WallTimer::hasPending ( )

Returns whether or not the timer has any pending events to call.

Definition at line 132 of file wall_timer.cpp.

◆ hasStarted()

bool ros::WallTimer::hasStarted ( ) const
inline

Definition at line 74 of file wall_timer.h.

◆ isValid()

bool ros::WallTimer::isValid ( )
inline

Definition at line 75 of file wall_timer.h.

◆ operator void *()

ros::WallTimer::operator void * ( )
inline

Definition at line 76 of file wall_timer.h.

◆ operator!=()

bool ros::WallTimer::operator!= ( const WallTimer rhs)
inline

Definition at line 88 of file wall_timer.h.

◆ operator<()

bool ros::WallTimer::operator< ( const WallTimer rhs)
inline

Definition at line 78 of file wall_timer.h.

◆ operator==()

bool ros::WallTimer::operator== ( const WallTimer rhs)
inline

Definition at line 83 of file wall_timer.h.

◆ setPeriod()

void ros::WallTimer::setPeriod ( const WallDuration period,
bool  reset = true 
)

Set the period of this timer.

Parameters
resetWhether to reset the timer. If true, timer ignores elapsed time and next cb occurs at now()+period

Definition at line 142 of file wall_timer.cpp.

◆ start()

void ros::WallTimer::start ( )

Start the timer. Does nothing if the timer is already started.

Definition at line 116 of file wall_timer.cpp.

◆ stop()

void ros::WallTimer::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 wall_timer.cpp.

Friends And Related Function Documentation

◆ NodeHandle

friend class NodeHandle
friend

Definition at line 125 of file wall_timer.h.

Member Data Documentation

◆ impl_

ImplPtr ros::WallTimer::impl_
private

Definition at line 123 of file wall_timer.h.


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


roscpp
Author(s): Morgan Quigley, Josh Faust, Brian Gerkey, Troy Straszheim
autogenerated on Fri Oct 4 2019 03:16:56