mbed libraries for KL25Z
Diff: DigitalOut.h
- Revision:
- 8:c14af7958ef5
- Parent:
- 0:8024c367e29f
- Child:
- 9:663789d7729f
--- a/DigitalOut.h Tue Oct 23 09:20:18 2012 +0000 +++ b/DigitalOut.h Fri Nov 09 11:33:53 2012 +0000 @@ -5,60 +5,57 @@ #define MBED_DIGITALOUT_H #include "platform.h" -#include "Base.h" - #include "gpio_api.h" namespace mbed { -/* Class: DigitalOut - * A digital output, used for setting the state of a pin +/** A digital output, used for setting the state of a pin * * Example: - * > // Toggle a LED - * > #include "mbed.h" - * > - * > DigitalOut led(LED1); - * > - * > int main() { - * > while(1) { - * > led = !led; - * > wait(0.2); - * > } - * > } + * @code + * // Toggle a LED + * #include "mbed.h" + * + * DigitalOut led(LED1); + * + * int main() { + * while(1) { + * led = !led; + * wait(0.2); + * } + * } + * @endcode */ -class DigitalOut : public Base { +class DigitalOut { public: - /* Constructor: DigitalOut - * Create a DigitalOut connected to the specified pin + /** Create a DigitalOut connected to the specified pin * - * Variables: - * pin - DigitalOut pin to connect to + * @param pin DigitalOut pin to connect to */ - DigitalOut(PinName pin, const char* name = NULL); + DigitalOut(PinName pin); - /* Function: write - * Set the output, specified as 0 or 1 (int) + /** Set the output, specified as 0 or 1 (int) * - * Variables: - * value - An integer specifying the pin output value, - * 0 for logical 0 and 1 (or any other non-zero value) for logical 1 + * @param value An integer specifying the pin output value, + * 0 for logical 0, 1 (or any other non-zero value) for logical 1 */ - void write(int value); + void write(int value) { + gpio_write(&gpio, value); + } - /* Function: read - * Return the output setting, represented as 0 or 1 (int) + /** Return the output setting, represented as 0 or 1 (int) * - * Variables: - * returns - An integer representing the output setting of the pin, - * 0 for logical 0 and 1 for logical 1 + * @returns + * an integer representing the output setting of the pin, + * 0 for logical 0, 1 for logical 1 */ - int read(); + int read() { + return gpio_read(&gpio); + } #ifdef MBED_OPERATORS - /* Function: operator= - * A shorthand for <write> + /** A shorthand for write() */ DigitalOut& operator= (int value) { write(value); @@ -70,19 +67,13 @@ return *this; } - /* Function: operator int() - * A shorthand for <read> + /** A shorthand for read() */ operator int() { return read(); } #endif -#ifdef MBED_RPC - virtual const struct rpc_method *get_rpc_methods(); - static struct rpc_class *get_rpc_class(); -#endif - protected: gpio_object gpio; };