Prusa3d Marlin fork
Public Member Functions | List of all members
TimerRemaining Class Reference
Inheritance diagram for TimerRemaining:
Inheritance graph
[legend]
Collaboration diagram for TimerRemaining:
Collaboration graph
[legend]

Public Member Functions

void start ()=delete
 
bool expired (unsigned long msPeriod)=delete
 
void start (unsigned long msPeriod)
 Start timer. More...
 
unsigned long remaining ()
 Time remaining to expiration. More...
 
bool expired ()
 Timer has expired. More...
 
- Public Member Functions inherited from Timer< unsigned long >
void start ()
 Start timer.
 
void stop ()
 
bool running () const
 
bool expired (unsigned long msPeriod)
 Timer has expired. More...
 
unsigned long elapsed ()
 Ticks since the timer was started. More...
 
bool expired_cont (unsigned long msPeriod)
 

Additional Inherited Members

- Protected Member Functions inherited from Timer< unsigned long >
unsigned long started () const
 

Member Function Documentation

◆ expired()

bool TimerRemaining::expired ( )
inline
Return values
trueTimer has expired.
falseTimer has not expired.

◆ remaining()

unsigned long TimerRemaining::remaining ( )
inline
Parameters
msPeriodtimer period in milliseconds
Returns
time remaining to expiration in milliseconds
Return values
0Timer has expired, or was not even started.

◆ start()

void TimerRemaining::start ( unsigned long  msPeriod)
inline
Parameters
msPeriodTime to expire in milliseconds

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