Sertel_Srinath Gopalan / USB_SERTEL_LOG

Soundharrajan

Fork of mbed by mbed official

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