yarp::os::TimerSettings Struct Reference

#include <yarp/os/Timer.h>

Public Member Functions
	TimerSettings (double inPeriod)
	TimerSettings (double inPeriod, size_t count, double seconds)
	TimerSettings (double inPeriod, size_t count, double seconds, double inTollerance)
bool	operator== (const TimerSettings &rhs) const

Public Attributes
double	period
double	totalTime
size_t	totalRunCount
double	tolerance

Detailed Description

Definition at line 50 of file Timer.h.

Constructor & Destructor Documentation

TimerSettings() [1/3]

yarp::os::TimerSettings::TimerSettings ( double  inPeriod )

inline

Definition at line 52 of file Timer.h.

TimerSettings() [2/3]

yarp::os::TimerSettings::TimerSettings ( double  inPeriod, size_t  count, double  seconds  )

inline

Definition at line 59 of file Timer.h.

TimerSettings() [3/3]

yarp::os::TimerSettings::TimerSettings ( double  inPeriod, size_t  count, double  seconds, double  inTollerance  )

inline

Definition at line 66 of file Timer.h.

Member Function Documentation

operator==()

bool yarp::os::TimerSettings::operator== ( const TimerSettings &  rhs ) const

inline

Definition at line 74 of file Timer.h.

Member Data Documentation

period

double yarp::os::TimerSettings::period

Parameters

period	the period of the timer in seconds
totalTime	the life of the timer in seconds. 0 == infinite. The lower between totalTime and totalRunCount*rate + execution delay will stop the timer
totalRunCount	the total count of execution. 0 == infinite. The lower between totalTime and totalRunCount*rate + execution delay will stop the timer
tolerance	the tolerance while checking the timer life

Definition at line 90 of file Timer.h.

tolerance

double yarp::os::TimerSettings::tolerance

Definition at line 93 of file Timer.h.

totalRunCount

size_t yarp::os::TimerSettings::totalRunCount

Definition at line 92 of file Timer.h.

totalTime

double yarp::os::TimerSettings::totalTime

Definition at line 91 of file Timer.h.

---

The documentation for this struct was generated from the following file:

• src/libYARP_os/src/yarp/os/Timer.h