ros::WallRate Class Reference

Class to help run loops at a desired frequency. This version always uses wall-clock time. More...

#include <rate.h>

Public Member Functions
WallDuration	cycleTime ()
	Get the actual run time of a cycle from start to sleep.
WallDuration	expectedCycleTime ()
	Get the expected cycle time -- one over the frequency passed in to the constructor.
void	reset ()
	Sets the start time for the rate to now.
bool	sleep ()
	Sleeps for any leftover time in a cycle. Calculated from the last time sleep, reset, or the constructor was called.
	WallRate (double frequency)
	Constructor, creates a Rate.
Private Attributes
WallDuration	actual_cycle_time_
WallDuration	expected_cycle_time_
WallTime	start_

Detailed Description

Class to help run loops at a desired frequency. This version always uses wall-clock time.

Definition at line 86 of file rate.h.

ros::WallRate::WallRate ( double frequency )

Constructor, creates a Rate.

Parameters:

frequency

The desired rate to run at in Hz

Definition at line 92 of file rate.cpp.

WallDuration ros::WallRate::cycleTime ( )

Get the actual run time of a cycle from start to sleep.

Definition at line 139 of file rate.cpp.

WallDuration ros::WallRate::expectedCycleTime ( ) [inline]

Get the expected cycle time -- one over the frequency passed in to the constructor.

Definition at line 115 of file rate.h.

void ros::WallRate::reset ( )

Sets the start time for the rate to now.

Definition at line 134 of file rate.cpp.

bool ros::WallRate::sleep ( )

Sleeps for any leftover time in a cycle. Calculated from the last time sleep, reset, or the constructor was called.

Returns:: Passes through the return value from WallDuration::sleep() if it slept, otherwise True

Definition at line 98 of file rate.cpp.

Definition at line 119 of file rate.h.

Definition at line 119 of file rate.h.

Definition at line 118 of file rate.h.

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