pfodParser 5.0.1 The pfodParser library is handles commands sent from the Android pfodApp, pfodApp supports WiFi, BLE, Bluetooth and SMS connections

pfodDelay.h
Go to the documentation of this file.
1 // pfodDelay.h
2 #ifndef PFOD_DELAY_H
3 #define PFOD_DELAY_H
4
5 /*
6 * (c)2018 Forward Computing and Control Pty. Ltd.
7 * NSW Australia, www.forward.com.au
8 * This code is not warranted to be fit for any purpose. You may only use it at your own risk.
9 * This generated code may be freely used for both private and commercial use
10 * provided this copyright is maintained.
11 */
12
13 class pfodDelay {
14 public:
15
16 pfodDelay();
17
22 void start(unsigned long delay);
23
29 void stop();
30
35 void repeat();
36
42 void restart();
43
47 void finish();
48
53 bool justFinished();
54
58 bool isRunning();
59
64 unsigned long getStartTime();
65
70 unsigned long remaining();
71
75 unsigned long delay();
76
77 private:
78 unsigned long mS_delay;
79 unsigned long startTime;
80 bool running; // true if delay running false when ended
81 bool finishNow; // true if finish() called to finish delay early, false after justFinished() returns true
82 };
83 #endif
pfodDelay
Definition: pfodDelay.h:13
pfodDelay::justFinished
bool justFinished()
Has the delay ended/expired or has finish() been called? justFinished() returns true just once when d...
pfodDelay::isRunning
bool isRunning()
Is the delay running, i.e.
pfodDelay::remaining
unsigned long remaining()
How many mS remaining until delay finishes Returns 0 if finished or stopped.
pfodDelay::repeat
void repeat()
repeat() Do same delay again but allow for a possible delay in calling justFinished()
pfodDelay::stop
void stop()
Stop the delay justFinished() will now never return true until after start(),restart() or repeat() ca...
pfodDelay::getStartTime
unsigned long getStartTime()
Returns the last time this delay was started, in mS, by calling start(), repeat() or restart() Return...
pfodDelay::pfodDelay
pfodDelay()
pfodDelay::restart
void restart()
restart() Start the same delay again starting from now Note: use repeat() when justFinished() returns...
pfodDelay::finish
void finish()
Force delay to end now.
pfodDelay::start
void start(unsigned long delay)
Start a delay of this many milliseconds.
pfodDelay::delay
unsigned long delay()
The delay set in start.