cc y / mbed

ads1115 only

Fork of mbed by mbed official

Timeout.h@43:e2ed12d17f06, 2012-10-26 (annotated)

Committer:
emilmont
Date:
Fri Oct 26 17:40:46 2012 +0100
Revision:
43:e2ed12d17f06
Parent:
27:7110ebee3484
Child:
44:24d45a770a51
Update documentation

Who changed what in which revision?

UserRevisionLine numberNew contents of line
simon.ford@mbed.co.uk 9:cf0d45ce28a6 1 /* mbed Microcontroller Library - Timeout
rolf.meyer@arm.com 11:1c1ebd0324fa 2 * Copyright (c) 2007-2009 ARM Limited. All rights reserved.
rolf.meyer@arm.com 11:1c1ebd0324fa 3 */
rolf.meyer@arm.com 11:1c1ebd0324fa 4
simon.ford@mbed.co.uk 9:cf0d45ce28a6 5 #ifndef MBED_TIMEOUT_H
simon.ford@mbed.co.uk 9:cf0d45ce28a6 6 #define MBED_TIMEOUT_H
simon.ford@mbed.co.uk 9:cf0d45ce28a6 7
simon.ford@mbed.co.uk 9:cf0d45ce28a6 8 #include "Ticker.h"
simon.ford@mbed.co.uk 9:cf0d45ce28a6 9
simon.ford@mbed.co.uk 9:cf0d45ce28a6 10 namespace mbed {
simon.ford@mbed.co.uk 9:cf0d45ce28a6 11
emilmont 43:e2ed12d17f06 12 /** A Timeout is used to call a function at a point in the future
simon.ford@mbed.co.uk 9:cf0d45ce28a6 13 *
emilmont 43:e2ed12d17f06 14 * You can use as many seperate Timeout objects as you require.
rolf.meyer@arm.com 11:1c1ebd0324fa 15 *
rolf.meyer@arm.com 11:1c1ebd0324fa 16 * Example:
emilmont 43:e2ed12d17f06 17 * @code
emilmont 43:e2ed12d17f06 18 * // Blink until timeout.
emilmont 43:e2ed12d17f06 19 *
emilmont 43:e2ed12d17f06 20 * #include "mbed.h"
emilmont 43:e2ed12d17f06 21 *
emilmont 43:e2ed12d17f06 22 * Timeout timeout;
emilmont 43:e2ed12d17f06 23 * DigitalOut led(LED1);
emilmont 43:e2ed12d17f06 24 *
emilmont 43:e2ed12d17f06 25 * int on = 1;
emilmont 43:e2ed12d17f06 26 *
emilmont 43:e2ed12d17f06 27 * void attimeout() {
emilmont 43:e2ed12d17f06 28 * on = 0;
emilmont 43:e2ed12d17f06 29 * }
emilmont 43:e2ed12d17f06 30 *
emilmont 43:e2ed12d17f06 31 * int main() {
emilmont 43:e2ed12d17f06 32 * timeout.attach(&attimeout, 5);
emilmont 43:e2ed12d17f06 33 * while(on) {
emilmont 43:e2ed12d17f06 34 * led = !led;
emilmont 43:e2ed12d17f06 35 * wait(0.2);
emilmont 43:e2ed12d17f06 36 * }
emilmont 43:e2ed12d17f06 37 * }
emilmont 43:e2ed12d17f06 38 * @endcode
simon.ford@mbed.co.uk 9:cf0d45ce28a6 39 */
simon.ford@mbed.co.uk 9:cf0d45ce28a6 40 class Timeout : public Ticker {
simon.ford@mbed.co.uk 9:cf0d45ce28a6 41
simon.ford@mbed.co.uk 9:cf0d45ce28a6 42 #if 0 // For documentation
simon.ford@mbed.co.uk 9:cf0d45ce28a6 43
emilmont 43:e2ed12d17f06 44 /** Attach a function to be called by the Timeout, specifiying the delay in seconds
simon.ford@mbed.co.uk 9:cf0d45ce28a6 45 *
emilmont 43:e2ed12d17f06 46 * @param fptr pointer to the function to be called
emilmont 43:e2ed12d17f06 47 * @param t the time before the call in seconds
simon.ford@mbed.co.uk 9:cf0d45ce28a6 48 */
simon.ford@mbed.co.uk 9:cf0d45ce28a6 49 void attach(void (*fptr)(void), float t) {
simon.ford@mbed.co.uk 9:cf0d45ce28a6 50 attach_us(fptr, t * 1000000.0f);
simon.ford@mbed.co.uk 9:cf0d45ce28a6 51 }
simon.ford@mbed.co.uk 9:cf0d45ce28a6 52
emilmont 43:e2ed12d17f06 53 /** Attach a member function to be called by the Timeout, specifiying the delay in seconds
simon.ford@mbed.co.uk 9:cf0d45ce28a6 54 *
emilmont 43:e2ed12d17f06 55 * @param tptr pointer to the object to call the member function on
emilmont 43:e2ed12d17f06 56 * @param mptr pointer to the member function to be called
emilmont 43:e2ed12d17f06 57 * @param t the time before the calls in seconds
simon.ford@mbed.co.uk 9:cf0d45ce28a6 58 */
simon.ford@mbed.co.uk 9:cf0d45ce28a6 59 template<typename T>
simon.ford@mbed.co.uk 9:cf0d45ce28a6 60 void attach(T* tptr, void (T::*mptr)(void), float t) {
simon.ford@mbed.co.uk 9:cf0d45ce28a6 61 attach_us(tptr, mptr, t * 1000000.0f);
simon.ford@mbed.co.uk 9:cf0d45ce28a6 62 }
simon.ford@mbed.co.uk 9:cf0d45ce28a6 63
emilmont 43:e2ed12d17f06 64 /** Attach a function to be called by the Timeout, specifiying the delay in micro-seconds
simon.ford@mbed.co.uk 9:cf0d45ce28a6 65 *
emilmont 43:e2ed12d17f06 66 * @param fptr pointer to the function to be called
emilmont 43:e2ed12d17f06 67 * @param t the time before the call in micro-seconds
simon.ford@mbed.co.uk 9:cf0d45ce28a6 68 */
simon.ford@mbed.co.uk 9:cf0d45ce28a6 69 void attach_us(void (*fptr)(void), unsigned int t) {
simon.ford@mbed.co.uk 9:cf0d45ce28a6 70 _function.attach(fptr);
simon.ford@mbed.co.uk 9:cf0d45ce28a6 71 setup(t);
simon.ford@mbed.co.uk 9:cf0d45ce28a6 72 }
simon.ford@mbed.co.uk 9:cf0d45ce28a6 73
emilmont 43:e2ed12d17f06 74 /** Attach a member function to be called by the Timeout, specifiying the delay in micro-seconds
simon.ford@mbed.co.uk 9:cf0d45ce28a6 75 *
emilmont 43:e2ed12d17f06 76 * @param tptr pointer to the object to call the member function on
emilmont 43:e2ed12d17f06 77 * @param mptr pointer to the member function to be called
emilmont 43:e2ed12d17f06 78 * @param t the time before the call in micro-seconds
simon.ford@mbed.co.uk 9:cf0d45ce28a6 79 */
simon.ford@mbed.co.uk 9:cf0d45ce28a6 80 template<typename T>
simon.ford@mbed.co.uk 9:cf0d45ce28a6 81 void attach_us(T* tptr, void (T::*mptr)(void), unsigned int t) {
simon.ford@mbed.co.uk 9:cf0d45ce28a6 82 _function.attach(tptr, mptr);
simon.ford@mbed.co.uk 9:cf0d45ce28a6 83 setup(t);
simon.ford@mbed.co.uk 9:cf0d45ce28a6 84 }
simon.ford@mbed.co.uk 9:cf0d45ce28a6 85
emilmont 43:e2ed12d17f06 86 /** Detach the function
simon.ford@mbed.co.uk 9:cf0d45ce28a6 87 */
simon.ford@mbed.co.uk 9:cf0d45ce28a6 88 void detach();
simon.ford@mbed.co.uk 9:cf0d45ce28a6 89
simon.ford@mbed.co.uk 9:cf0d45ce28a6 90 #endif
simon.ford@mbed.co.uk 9:cf0d45ce28a6 91
simon.ford@mbed.co.uk 9:cf0d45ce28a6 92 protected:
simon.ford@mbed.co.uk 9:cf0d45ce28a6 93
rolf.meyer@arm.com 11:1c1ebd0324fa 94 virtual void handler();
simon.ford@mbed.co.uk 9:cf0d45ce28a6 95
rolf.meyer@arm.com 11:1c1ebd0324fa 96 };
rolf.meyer@arm.com 11:1c1ebd0324fa 97
rolf.meyer@arm.com 11:1c1ebd0324fa 98 } // namespace mbed
simon.ford@mbed.co.uk 9:cf0d45ce28a6 99
simon.ford@mbed.co.uk 9:cf0d45ce28a6 100 #endif