mbed library sources
Dependents: frdm_kl05z_gpio_test
Fork of mbed-src by
Diff: api/DigitalOut.h
- Revision:
- 10:3bc89ef62ce7
- Parent:
- 9:0ce32e54c9a7
- Child:
- 13:0645d8841f51
diff -r 0ce32e54c9a7 -r 3bc89ef62ce7 api/DigitalOut.h --- a/api/DigitalOut.h Mon Jun 10 16:03:00 2013 +0100 +++ b/api/DigitalOut.h Fri Jun 14 17:49:17 2013 +0100 @@ -1,97 +1,97 @@ -/* mbed Microcontroller Library - * Copyright (c) 2006-2013 ARM Limited - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ -#ifndef MBED_DIGITALOUT_H -#define MBED_DIGITALOUT_H - -#include "platform.h" -#include "gpio_api.h" - -namespace mbed { - -/** A digital output, used for setting the state of a pin - * - * Example: - * @code - * // Toggle a LED - * #include "mbed.h" - * - * DigitalOut led(LED1); - * - * int main() { - * while(1) { - * led = !led; - * wait(0.2); - * } - * } - * @endcode - */ -class DigitalOut { - -public: - /** Create a DigitalOut connected to the specified pin - * - * @param pin DigitalOut pin to connect to - */ - DigitalOut(PinName pin) { - gpio_init(&gpio, pin, PIN_OUTPUT); - } - - /** Set the output, specified as 0 or 1 (int) - * - * @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) { - gpio_write(&gpio, value); - } - - /** Return the output setting, represented as 0 or 1 (int) - * - * @returns - * an integer representing the output setting of the pin, - * 0 for logical 0, 1 for logical 1 - */ - int read() { - return gpio_read(&gpio); - } - -#ifdef MBED_OPERATORS - /** A shorthand for write() - */ - DigitalOut& operator= (int value) { - write(value); - return *this; - } - - DigitalOut& operator= (DigitalOut& rhs) { - write(rhs.read()); - return *this; - } - - /** A shorthand for read() - */ - operator int() { - return read(); - } -#endif - -protected: - gpio_t gpio; -}; - -} // namespace mbed - -#endif +/* mbed Microcontroller Library + * Copyright (c) 2006-2013 ARM Limited + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +#ifndef MBED_DIGITALOUT_H +#define MBED_DIGITALOUT_H + +#include "platform.h" +#include "gpio_api.h" + +namespace mbed { + +/** A digital output, used for setting the state of a pin + * + * Example: + * @code + * // Toggle a LED + * #include "mbed.h" + * + * DigitalOut led(LED1); + * + * int main() { + * while(1) { + * led = !led; + * wait(0.2); + * } + * } + * @endcode + */ +class DigitalOut { + +public: + /** Create a DigitalOut connected to the specified pin + * + * @param pin DigitalOut pin to connect to + */ + DigitalOut(PinName pin) { + gpio_init(&gpio, pin, PIN_OUTPUT); + } + + /** Set the output, specified as 0 or 1 (int) + * + * @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) { + gpio_write(&gpio, value); + } + + /** Return the output setting, represented as 0 or 1 (int) + * + * @returns + * an integer representing the output setting of the pin, + * 0 for logical 0, 1 for logical 1 + */ + int read() { + return gpio_read(&gpio); + } + +#ifdef MBED_OPERATORS + /** A shorthand for write() + */ + DigitalOut& operator= (int value) { + write(value); + return *this; + } + + DigitalOut& operator= (DigitalOut& rhs) { + write(rhs.read()); + return *this; + } + + /** A shorthand for read() + */ + operator int() { + return read(); + } +#endif + +protected: + gpio_t gpio; +}; + +} // namespace mbed + +#endif