Class to help run loops at a desired frequency. More...

#include <rate.h>

Public Member Functions
Duration	cycleTime () const
	Get the actual run time of a cycle from start to sleep. More...

Duration	expectedCycleTime () const
	Get the expected cycle time – one over the frequency passed in to the constructor. More...

	Rate (double frequency)
	Constructor, creates a Rate. More...

	Rate (const Duration &)

void	reset ()
	Sets the start time for the rate to now. More...

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

Detailed Description

Class to help run loops at a desired frequency.

Definition at line 51 of file rate.h.

Constructor & Destructor Documentation

ros::Rate::Rate ( double frequency )

Constructor, creates a Rate.

Parameters

frequency The desired rate to run at in Hz

Definition at line 42 of file rate.cpp.

ros::Rate::Rate ( const Duration & d )

explicit

Definition at line 48 of file rate.cpp.

Duration ros::Rate::cycleTime ( ) const

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

Definition at line 96 of file rate.cpp.

Duration ros::Rate::expectedCycleTime ( ) const

inline

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

Definition at line 81 of file rate.h.

void ros::Rate::reset ( )

Sets the start time for the rate to now.

Definition at line 91 of file rate.cpp.

bool ros::Rate::sleep ( )

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

Definition at line 54 of file rate.cpp.

Duration ros::Rate::actual_cycle_time_

private

Definition at line 85 of file rate.h.

Duration ros::Rate::expected_cycle_time_

private

Definition at line 85 of file rate.h.

Time ros::Rate::start_

private

Definition at line 84 of file rate.h.

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