Diff: AnalogOut.h

Revision:

11:1c1ebd0324fa

Parent:

5:62573be585e9

Child:

27:7110ebee3484

--- a/AnalogOut.h	Thu May 14 14:44:00 2009 +0000
+++ b/AnalogOut.h	Fri Aug 28 12:10:11 2009 +0000
@@ -6,12 +6,31 @@
 #ifndef MBED_ANALOGOUT_H
 #define MBED_ANALOGOUT_H
 
+#include "platform.h"
+#include "PinNames.h"
+#include "PeripheralNames.h"
 #include "Base.h"
 
 namespace mbed {
 
 /* Class: AnalogOut
  *  An analog output, used for setting the voltage on a pin
+ *
+ * Example:
+ * > // Make a sawtooth output
+ * > 
+ * > #include "mbed.h"
+ * > 
+ * > AnalogOut tri(p18);
+ * > int main() {
+ * >     while(1) {
+ * >         tri = tri + 0.01;
+ * >         wait_us(1);
+ * >         if(tri == 1) {
+ * >             tri = 0;
+ * >         }
+ * >     }
+ * > }
  */
 class AnalogOut : public Base {
 
@@ -23,18 +42,18 @@
 	 * Variables:
 	 *  pin - AnalogOut pin to connect to (18)
 	 */
-	AnalogOut(int pin, const char *name = NULL);
+	AnalogOut(PinName pin, const char *name = NULL);
 	
-	/* Function: write
-	 *  Set the output voltage, specified as a percentage (float)
-	 *
-	 * Variables:
-	 *  percent - A floating-point value representing the output voltage, 
-	 *    specified as a percentage. The value should lie between
-	 *    0.0f (representing 0v / 0%) and 1.0f (representing 3.3v / 100%).
-	 *    Values outside this range will be saturated to 0.0f or 1.0f.	 
-	 */
-    void write(float percent);
+    /* Function: write
+     *  Set the output voltage, specified as a percentage (float)
+     *
+     * Variables:
+     *  percent - A floating-point value representing the output voltage, 
+     *    specified as a percentage. The value should lie between
+     *    0.0f (representing 0v / 0%) and 1.0f (representing 3.3v / 100%).
+     *    Values outside this range will be saturated to 0.0f or 1.0f.	 
+     */
+    void write(float value);
     
     /* Function: write_u16
      *  Set the output voltage, represented as an unsigned short in the range [0x0, 0xFFFF]
@@ -45,22 +64,21 @@
      */
     void write_u16(unsigned short value);
 
-    void write_v(float v);
-    void write_mv(int mv);
-    
     /* Function: read
-	 *  Return the current output voltage setting, measured as a percentage (float)
+     *  Return the current output voltage setting, measured as a percentage (float)
      *
      * Variables:
-	 *  returns - A floating-point value representing the current voltage being output on the pin, 
-	 *    measured as a percentage. The returned value will lie between
-	 *    0.0f (representing 0v / 0%) and 1.0f (representing 3.3v / 100%).
-	 *
-	 * Note:
-	 *  This value may not match exactly the value set by a previous <write>.
-	 */	
+     *  returns - A floating-point value representing the current voltage being output on the pin, 
+     *    measured as a percentage. The returned value will lie between
+     *    0.0f (representing 0v / 0%) and 1.0f (representing 3.3v / 100%).
+     *
+     * Note:
+     *  This value may not match exactly the value set by a previous <write>.
+     */	
     float read();
 
+
+#ifdef MBED_OPERATORS
     /* Function: operator=
      *  An operator shorthand for <write()>
      */
@@ -68,16 +86,23 @@
 	AnalogOut& operator= (AnalogOut& rhs);
 
     /* Function: operator float()
-	 *  An operator shorthand for <read()>
-	 */	
+     *  An operator shorthand for <read()>
+     */	
 	operator float();
+#endif
 
+#ifdef MBED_RPC
     virtual const struct rpc_method *get_rpc_methods();
     static struct rpc_class *get_rpc_class();
+#endif
+
+protected:
+
+	DACName _dac;
 
 };
 
-}
+} // namespace mbed
 
 #endif