jesus antonio lopez / mbed

...

Dependents:   2doejemplo Labo_TRSE_Drone

Fork of mbed by mbed official

Timeout.h@11:1c1ebd0324fa, 2009-08-28 (annotated)

Committer:
rolf.meyer@arm.com
Date:
Fri Aug 28 12:10:11 2009 +0000
Revision:
11:1c1ebd0324fa
Parent:
9:cf0d45ce28a6
Child:
27:7110ebee3484
A shiny new version

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