File content as of revision 8:c14af7958ef5:

/* mbed Microcontroller Library - DigitalIn
 * Copyright (c) 2006-2011 ARM Limited. All rights reserved.
 */
#ifndef MBED_DIGITALIN_H
#define MBED_DIGITALIN_H

#include "platform.h"

#include "gpio_api.h"

namespace mbed {

/** A digital input, used for reading the state of a pin
 *
 * Example:
 * @code
 * // Flash an LED while a DigitalIn is true
 * 
 * #include "mbed.h"
 * 
 * DigitalIn enable(p5);
 * DigitalOut led(LED1);
 * 
 * int main() {
 *     while(1) {
 *         if(enable) {
 *             led = !led;
 *         }
 *         wait(0.25);
 *     }
 * }
 * @endcode
 */
class DigitalIn {

public:
    /** Create a DigitalIn connected to the specified pin
     *
     *  @param pin DigitalIn pin to connect to
     *  @param name (optional) A string to identify the object
     */
    DigitalIn(PinName pin);
    
    /** Read the input, represented as 0 or 1 (int)
     *
     *  @returns
     *    An integer representing the state of the input pin, 
     *    0 for logical 0, 1 for logical 1
     */
    int read();
    
    /** Set the input pin mode
     *
     *  @param mode PullUp, PullDown, PullNone, OpenDrain
     */
    void mode(PinMode pull);
    
#ifdef MBED_OPERATORS
    /** An operator shorthand for read()
     */
    operator int() {
        return read();
    }
#endif

protected:
    gpio_object gpio;
};

} // namespace mbed

#endif