Diff: Timer.h

Revision:

11:1c1ebd0324fa

Parent:

5:62573be585e9

Child:

27:7110ebee3484

--- a/Timer.h	Thu May 14 14:44:00 2009 +0000
+++ b/Timer.h	Fri Aug 28 12:10:11 2009 +0000
@@ -1,71 +1,95 @@
-/* mbed Microcontroller Library - Timer
- * Copyright (c) 2007-2008, sford
- */
- 
-#ifndef MBED_TIMER_H
-#define MBED_TIMER_H
-
-#include "Base.h"
-
-namespace mbed {
-
-/* Class: Timer
- *  A general purpose timer 
- */
-class Timer : public Base {
-
-public:
-
-	Timer(const char *name = NULL);
-	
-	/* Group: Access Methods */
-		
-	/* Function: start
-	 *  Start the timer
-	 */
-	void start(); 
-	
-	/* Function: stop
-	 *  Stop the timer
-	 */
-	void stop(); 
-	
-	/* Function: reset
-	 *  Reset the timer to 0. 
-	 *
-	 * If it was already counting, it will continue
-	 */
-	void reset();
-
-	/* Function: read
-	 *  Get the time passed in seconds
-	 */
-	float read();
-	
-	/* Function: read_ms
-	 *  Get the time passed in mili-seconds
-	 */
-	int read_ms();
-
-	/* Function: read_us
-	 *  Get the time passed in micro-seconds
-	 */
-	int read_us();
-
-	operator float();
-
-	int slicetime();
-	
-        int _running;          // whether the timer is running
-	unsigned int _start;   // the start time of the latest slice
-	int _time;             // any accumulated time from previous slices
-
-    virtual const struct rpc_method *get_rpc_methods();
-    static struct rpc_class *get_rpc_class();
-
-};
-
-}
-
-#endif
-
+/* mbed Microcontroller Library - Timer
+ * Copyright (c) 2007-2009 ARM Limited. All rights reserved.
+ * sford
+ */ 
+ 
+#ifndef MBED_TIMER_H
+#define MBED_TIMER_H
+
+#include "platform.h"
+#include "PinNames.h"
+#include "PeripheralNames.h"
+#include "Base.h"
+
+namespace mbed {
+
+/* Class: Timer
+ *  A general purpose timer 
+ *
+ * Example:
+ * > // Count the time to toggle a LED
+ * >
+ * > #include "mbed.h"
+ * > 
+ * > Timer timer;
+ * > DigitalOut led(LED1);
+ * > int begin, end;
+ * > 
+ * > int main() {
+ * >     timer.start();
+ * >     begin = timer.read_us();
+ * >     led = !led;
+ * >     end = timer.read_us();
+ * >     printf("Toggle the led takes %d us", end - begin);
+ * > }
+ */
+class Timer : public Base {
+
+public:
+
+    Timer(const char *name = NULL);
+    
+    /* Function: start
+     *  Start the timer
+     */
+    void start(); 
+
+    /* Function: stop
+     *  Stop the timer
+     */
+    void stop(); 
+
+    /* Function: reset
+     *  Reset the timer to 0. 
+     *
+     * If it was already counting, it will continue
+     */
+    void reset();
+
+    /* Function: read
+     *  Get the time passed in seconds
+     */
+    float read();
+
+    /* Function: read_ms
+     *  Get the time passed in mili-seconds
+     */
+    int read_ms();
+
+    /* Function: read_us
+     *  Get the time passed in micro-seconds
+     */
+    int read_us();
+
+#ifdef MBED_OPERATORS 
+    operator float();
+#endif
+
+#ifdef MBED_RPC
+    virtual const struct rpc_method *get_rpc_methods();
+    static struct rpc_class *get_rpc_class();
+#endif
+
+protected:
+
+    int slicetime();    
+    int _running;          // whether the timer is running
+    unsigned int _start;   // the start time of the latest slice
+    int _time;             // any accumulated time from previous slices
+    
+};
+
+} // namespace mbed
+
+#endif
+