YARP
Yet Another Robot Platform
Public Member Functions | Public Attributes | List of all members
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 60 of file Timer.h.

Constructor & Destructor Documentation

◆ TimerSettings() [1/3]

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

Definition at line 62 of file Timer.h.

◆ TimerSettings() [2/3]

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

Definition at line 69 of file Timer.h.

◆ TimerSettings() [3/3]

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

Definition at line 76 of file Timer.h.

Member Function Documentation

◆ operator==()

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

Definition at line 84 of file Timer.h.

Member Data Documentation

◆ period

double yarp::os::TimerSettings::period
Parameters
periodthe period of the timer in seconds
totalTimethe life of the timer in seconds. 0 == infinite. The lower between totalTime and totalRunCount*rate + execution delay will stop the timer
totalRunCountthe total count of execution. 0 == infinite. The lower between totalTime and totalRunCount*rate + execution delay will stop the timer
tolerancethe tolerance while checking the timer life

Definition at line 100 of file Timer.h.

◆ tolerance

double yarp::os::TimerSettings::tolerance

Definition at line 103 of file Timer.h.

◆ totalRunCount

size_t yarp::os::TimerSettings::totalRunCount

Definition at line 102 of file Timer.h.

◆ totalTime

double yarp::os::TimerSettings::totalTime

Definition at line 101 of file Timer.h.

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