mbed libraries for KL25Z
Diff: DigitalInOut.h
- Revision:
- 2:e9a661555b58
- Parent:
- 0:8024c367e29f
- Child:
- 8:c14af7958ef5
--- a/DigitalInOut.h Fri Oct 05 15:45:13 2012 +0000 +++ b/DigitalInOut.h Wed Oct 10 14:14:12 2012 +0000 @@ -1,97 +1,97 @@ -/* mbed Microcontroller Library - DigitalInOut - * Copyright (c) 2006-2011 ARM Limited. All rights reserved. - */ -#ifndef MBED_DIGITALINOUT_H -#define MBED_DIGITALINOUT_H - -#include "platform.h" -#include "Base.h" - -#include "gpio_api.h" - -namespace mbed { - -/* Class: DigitalInOut - * A digital input/output, used for setting or reading a bi-directional pin - */ -class DigitalInOut : public Base { - -public: - /* Constructor: DigitalInOut - * Create a DigitalInOut connected to the specified pin - * - * Variables: - * pin - DigitalInOut pin to connect to - */ - DigitalInOut(PinName pin, const char* name = NULL); - - /* Function: write - * 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 - */ - void write(int value); - - /* Function: read - * Return the output setting, represented as 0 or 1 (int) - * - * Variables: - * returns - An integer representing the output setting of the pin if it is an output, - * or read the input if set as an input - */ - int read(); - - /* Function: output - * Set as an output - */ - void output(); - - /* Function: input - * Set as an input - */ - void input(); - - /* Function: mode - * Set the input pin mode - * - * Variables: - * mode - PullUp, PullDown, PullNone, OpenDrain - */ - void mode(PinMode pull); - -#ifdef MBED_OPERATORS - /* Function: operator= - * A shorthand for <write> - */ - DigitalInOut& operator= (int value) { - write(value); - return *this; - } - - DigitalInOut& operator= (DigitalInOut& rhs) { - write(rhs.read()); - return *this; - } - - /* Function: operator int() - * 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; -}; - -} // namespace mbed - -#endif +/* mbed Microcontroller Library - DigitalInOut + * Copyright (c) 2006-2011 ARM Limited. All rights reserved. + */ +#ifndef MBED_DIGITALINOUT_H +#define MBED_DIGITALINOUT_H + +#include "platform.h" +#include "Base.h" + +#include "gpio_api.h" + +namespace mbed { + +/* Class: DigitalInOut + * A digital input/output, used for setting or reading a bi-directional pin + */ +class DigitalInOut : public Base { + +public: + /* Constructor: DigitalInOut + * Create a DigitalInOut connected to the specified pin + * + * Variables: + * pin - DigitalInOut pin to connect to + */ + DigitalInOut(PinName pin, const char* name = NULL); + + /* Function: write + * 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 + */ + void write(int value); + + /* Function: read + * Return the output setting, represented as 0 or 1 (int) + * + * Variables: + * returns - An integer representing the output setting of the pin if it is an output, + * or read the input if set as an input + */ + int read(); + + /* Function: output + * Set as an output + */ + void output(); + + /* Function: input + * Set as an input + */ + void input(); + + /* Function: mode + * Set the input pin mode + * + * Variables: + * mode - PullUp, PullDown, PullNone, OpenDrain + */ + void mode(PinMode pull); + +#ifdef MBED_OPERATORS + /* Function: operator= + * A shorthand for <write> + */ + DigitalInOut& operator= (int value) { + write(value); + return *this; + } + + DigitalInOut& operator= (DigitalInOut& rhs) { + write(rhs.read()); + return *this; + } + + /* Function: operator int() + * 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; +}; + +} // namespace mbed + +#endif