Mihail Stoyanov / mbed

Fork of the official mbed C/C++ SDK provides the software platform and libraries to build your applications. The fork has the documentation converted to Doxygen format

Dependents:   NervousPuppySprintOne NervousPuppySprint2602 Robot WarehouseBot1 ... more

Fork of mbed by mbed official

Ticker.h@4:5d1359a283bc, 2008-11-27 (annotated)

Committer:
simon.ford@mbed.co.uk
Date:
Thu Nov 27 16:23:24 2008 +0000
Revision:
4:5d1359a283bc
Parent:
3:aefd12a1f1c5
Child:
9:cf0d45ce28a6
New version of framework: vectors, environment, platform, base and file system

Who changed what in which revision?

UserRevisionLine numberNew contents of line
simon.ford@mbed.co.uk 4:5d1359a283bc 1 /* mbed Microcontroller Library - Ticker
simon.ford@mbed.co.uk 4:5d1359a283bc 2 * Copyright (c) 2007-2008, sford
simon.ford@mbed.co.uk 4:5d1359a283bc 3 */
simon.ford@mbed.co.uk 4:5d1359a283bc 4
simon.ford@mbed.co.uk 4:5d1359a283bc 5 #ifndef MBED_TICKER_H
simon.ford@mbed.co.uk 4:5d1359a283bc 6 #define MBED_TICKER_H
simon.ford@mbed.co.uk 4:5d1359a283bc 7
simon.ford@mbed.co.uk 4:5d1359a283bc 8 #include "TimerEvent.h"
simon.ford@mbed.co.uk 4:5d1359a283bc 9 #include "FunctionPointer.h"
simon.ford@mbed.co.uk 4:5d1359a283bc 10
simon.ford@mbed.co.uk 4:5d1359a283bc 11 namespace mbed {
simon.ford@mbed.co.uk 4:5d1359a283bc 12
simon.ford@mbed.co.uk 4:5d1359a283bc 13 /* Class: Ticker
simon.ford@mbed.co.uk 4:5d1359a283bc 14 * A Ticker is used to call a function at a recurring interval
simon.ford@mbed.co.uk 4:5d1359a283bc 15 *
simon.ford@mbed.co.uk 4:5d1359a283bc 16 * You can use as many seperate Ticker objects as you require.
simon.ford@mbed.co.uk 4:5d1359a283bc 17 */
simon.ford@mbed.co.uk 4:5d1359a283bc 18 class Ticker : public TimerEvent {
simon.ford@mbed.co.uk 4:5d1359a283bc 19
simon.ford@mbed.co.uk 4:5d1359a283bc 20 public:
simon.ford@mbed.co.uk 4:5d1359a283bc 21
simon.ford@mbed.co.uk 4:5d1359a283bc 22 /* Function: attach
simon.ford@mbed.co.uk 4:5d1359a283bc 23 * Attach a function to be called by the Ticker, specifiying the interval in seconds
simon.ford@mbed.co.uk 4:5d1359a283bc 24 *
simon.ford@mbed.co.uk 4:5d1359a283bc 25 * Variables:
simon.ford@mbed.co.uk 4:5d1359a283bc 26 * fptr - pointer to the function to be called
simon.ford@mbed.co.uk 4:5d1359a283bc 27 * t - the time between calls in seconds
simon.ford@mbed.co.uk 4:5d1359a283bc 28 */
simon.ford@mbed.co.uk 4:5d1359a283bc 29 void attach(void (*fptr)(void), float t) {
simon.ford@mbed.co.uk 4:5d1359a283bc 30 attach_us(fptr, t * 1000000.0f);
simon.ford@mbed.co.uk 4:5d1359a283bc 31 }
simon.ford@mbed.co.uk 4:5d1359a283bc 32
simon.ford@mbed.co.uk 4:5d1359a283bc 33 /* Function: attach
simon.ford@mbed.co.uk 4:5d1359a283bc 34 * Attach a member function to be called by the Ticker, specifiying the interval in seconds
simon.ford@mbed.co.uk 4:5d1359a283bc 35 *
simon.ford@mbed.co.uk 4:5d1359a283bc 36 * Variables:
simon.ford@mbed.co.uk 4:5d1359a283bc 37 * tptr - pointer to the object to call the member function on
simon.ford@mbed.co.uk 4:5d1359a283bc 38 * mptr - pointer to the member function to be called
simon.ford@mbed.co.uk 4:5d1359a283bc 39 * t - the time between calls in seconds
simon.ford@mbed.co.uk 4:5d1359a283bc 40 */
simon.ford@mbed.co.uk 4:5d1359a283bc 41 template<typename T>
simon.ford@mbed.co.uk 4:5d1359a283bc 42 void attach(T* tptr, void (T::*mptr)(void), float t) {
simon.ford@mbed.co.uk 4:5d1359a283bc 43 attach_us(tptr, mptr, t * 1000000.0f);
simon.ford@mbed.co.uk 4:5d1359a283bc 44 }
simon.ford@mbed.co.uk 4:5d1359a283bc 45
simon.ford@mbed.co.uk 4:5d1359a283bc 46 /* Function: attach_us
simon.ford@mbed.co.uk 4:5d1359a283bc 47 * Attach a function to be called by the Ticker, specifiying the interval in micro-seconds
simon.ford@mbed.co.uk 4:5d1359a283bc 48 *
simon.ford@mbed.co.uk 4:5d1359a283bc 49 * Variables:
simon.ford@mbed.co.uk 4:5d1359a283bc 50 * fptr - pointer to the function to be called
simon.ford@mbed.co.uk 4:5d1359a283bc 51 * t - the time between calls in micro-seconds
simon.ford@mbed.co.uk 4:5d1359a283bc 52 */
simon.ford@mbed.co.uk 4:5d1359a283bc 53 void attach_us(void (*fptr)(void), unsigned int t) {
simon.ford@mbed.co.uk 4:5d1359a283bc 54 _function.attach(fptr);
simon.ford@mbed.co.uk 4:5d1359a283bc 55 setup(t);
simon.ford@mbed.co.uk 4:5d1359a283bc 56 }
simon.ford@mbed.co.uk 4:5d1359a283bc 57
simon.ford@mbed.co.uk 4:5d1359a283bc 58 /* Function: attach_us
simon.ford@mbed.co.uk 4:5d1359a283bc 59 * Attach a member function to be called by the Ticker, specifiying the interval in micro-seconds
simon.ford@mbed.co.uk 4:5d1359a283bc 60 *
simon.ford@mbed.co.uk 4:5d1359a283bc 61 * Variables:
simon.ford@mbed.co.uk 4:5d1359a283bc 62 * tptr - pointer to the object to call the member function on
simon.ford@mbed.co.uk 4:5d1359a283bc 63 * mptr - pointer to the member function to be called
simon.ford@mbed.co.uk 4:5d1359a283bc 64 * t - the time between calls in micro-seconds
simon.ford@mbed.co.uk 4:5d1359a283bc 65 */
simon.ford@mbed.co.uk 4:5d1359a283bc 66 template<typename T>
simon.ford@mbed.co.uk 4:5d1359a283bc 67 void attach_us(T* tptr, void (T::*mptr)(void), unsigned int t) {
simon.ford@mbed.co.uk 4:5d1359a283bc 68 _function.attach(tptr, mptr);
simon.ford@mbed.co.uk 4:5d1359a283bc 69 setup(t);
simon.ford@mbed.co.uk 4:5d1359a283bc 70 }
simon.ford@mbed.co.uk 4:5d1359a283bc 71
simon.ford@mbed.co.uk 4:5d1359a283bc 72 /* Function: detach
simon.ford@mbed.co.uk 4:5d1359a283bc 73 * Detach the function
simon.ford@mbed.co.uk 4:5d1359a283bc 74 */
simon.ford@mbed.co.uk 4:5d1359a283bc 75 void detach();
simon.ford@mbed.co.uk 4:5d1359a283bc 76
simon.ford@mbed.co.uk 4:5d1359a283bc 77 protected:
simon.ford@mbed.co.uk 4:5d1359a283bc 78
simon.ford@mbed.co.uk 4:5d1359a283bc 79 void setup(unsigned int t);
simon.ford@mbed.co.uk 4:5d1359a283bc 80 virtual void handler();
simon.ford@mbed.co.uk 4:5d1359a283bc 81
simon.ford@mbed.co.uk 4:5d1359a283bc 82 unsigned int _delay;
simon.ford@mbed.co.uk 4:5d1359a283bc 83 FunctionPointer _function;
simon.ford@mbed.co.uk 4:5d1359a283bc 84
simon.ford@mbed.co.uk 4:5d1359a283bc 85 };
simon.ford@mbed.co.uk 4:5d1359a283bc 86
simon.ford@mbed.co.uk 4:5d1359a283bc 87 }
simon.ford@mbed.co.uk 4:5d1359a283bc 88
simon.ford@mbed.co.uk 4:5d1359a283bc 89 #endif