Mihail Stoyanov / mbed

Fork of the official mbed C/C++ SDK provides the software platform and libraries to build your applications. The fork has the documentation converted to Doxygen format

Dependents:   NervousPuppySprintOne NervousPuppySprint2602 Robot WarehouseBot1 ... more

Fork of mbed by mbed official

DigitalOut.h@2:969fc1867111, 2008-09-18 (annotated)

Committer:
simon.ford@mbed.co.uk
Date:
Thu Sep 18 14:02:33 2008 +0000
Revision:
2:969fc1867111
Parent:
1:6b7f447ca868
Child:
3:aefd12a1f1c5
Update some autodoc to see the results

Who changed what in which revision?

UserRevisionLine numberNew contents of line
simon.ford@mbed.co.uk 0:82220227f4fa 1 /* mbed Microcontroller Library - DigitalOut
simon.ford@mbed.co.uk 0:82220227f4fa 2 * Copyright (c) 2007-2008, sford
simon.ford@mbed.co.uk 0:82220227f4fa 3 */
simon.ford@mbed.co.uk 0:82220227f4fa 4
simon.ford@mbed.co.uk 0:82220227f4fa 5 #ifndef MBED_DIGITALOUT_H
simon.ford@mbed.co.uk 0:82220227f4fa 6 #define MBED_DIGITALOUT_H
simon.ford@mbed.co.uk 0:82220227f4fa 7
simon.ford@mbed.co.uk 0:82220227f4fa 8 #include "Base.h"
simon.ford@mbed.co.uk 0:82220227f4fa 9 #include "LPC2300.h"
simon.ford@mbed.co.uk 0:82220227f4fa 10
simon.ford@mbed.co.uk 0:82220227f4fa 11 namespace mbed {
simon.ford@mbed.co.uk 0:82220227f4fa 12
simon.ford@mbed.co.uk 0:82220227f4fa 13 /* Class: DigitalOut
simon.ford@mbed.co.uk 0:82220227f4fa 14 * A digital output, used for setting the state of a pin
simon.ford@mbed.co.uk 0:82220227f4fa 15 */
simon.ford@mbed.co.uk 0:82220227f4fa 16 class DigitalOut : public Base {
simon.ford@mbed.co.uk 0:82220227f4fa 17
simon.ford@mbed.co.uk 0:82220227f4fa 18 public:
simon.ford@mbed.co.uk 0:82220227f4fa 19
simon.ford@mbed.co.uk 0:82220227f4fa 20 /* Constructor: DigitalOut
simon.ford@mbed.co.uk 0:82220227f4fa 21 * Create a DigitalOut connected to the specified pin
simon.ford@mbed.co.uk 0:82220227f4fa 22 *
simon.ford@mbed.co.uk 0:82220227f4fa 23 * Variables:
simon.ford@mbed.co.uk 0:82220227f4fa 24 * pin - DigitalOut pin to connect to (5-30)
simon.ford@mbed.co.uk 0:82220227f4fa 25 */
simon.ford@mbed.co.uk 0:82220227f4fa 26 DigitalOut(int pin);
simon.ford@mbed.co.uk 0:82220227f4fa 27
simon.ford@mbed.co.uk 0:82220227f4fa 28 /* Function: write
simon.ford@mbed.co.uk 0:82220227f4fa 29 * Set the output, specified as 0 or 1 (int)
simon.ford@mbed.co.uk 0:82220227f4fa 30 *
simon.ford@mbed.co.uk 0:82220227f4fa 31 * Variables:
simon.ford@mbed.co.uk 0:82220227f4fa 32 * value - An integer specifying the pin output value,
simon.ford@mbed.co.uk 0:82220227f4fa 33 * 0 for logical 0 (0v) and 1 (or any other non-zero value) for logical 1 (3.3v).
simon.ford@mbed.co.uk 0:82220227f4fa 34 */
simon.ford@mbed.co.uk 0:82220227f4fa 35 void write(int value);
simon.ford@mbed.co.uk 0:82220227f4fa 36
simon.ford@mbed.co.uk 0:82220227f4fa 37 /* Function: read
simon.ford@mbed.co.uk 0:82220227f4fa 38 * Return the output setting, represented as 0 or 1 (int)
simon.ford@mbed.co.uk 0:82220227f4fa 39 *
simon.ford@mbed.co.uk 0:82220227f4fa 40 * Variables:
simon.ford@mbed.co.uk 0:82220227f4fa 41 * returns - An integer representing the output setting of the pin,
simon.ford@mbed.co.uk 0:82220227f4fa 42 * 0 for logical 0 (0v) and 1 for logical 1 (3.3v)
simon.ford@mbed.co.uk 0:82220227f4fa 43 */
simon.ford@mbed.co.uk 0:82220227f4fa 44 int read();
simon.ford@mbed.co.uk 0:82220227f4fa 45
simon.ford@mbed.co.uk 0:82220227f4fa 46 /* Function: operator=
simon.ford@mbed.co.uk 0:82220227f4fa 47 * A shorthand for <write>
simon.ford@mbed.co.uk 0:82220227f4fa 48 */
simon.ford@mbed.co.uk 0:82220227f4fa 49 DigitalOut& operator= (int v);
simon.ford@mbed.co.uk 0:82220227f4fa 50 DigitalOut& operator= (DigitalOut& rhs);
simon.ford@mbed.co.uk 0:82220227f4fa 51
simon.ford@mbed.co.uk 0:82220227f4fa 52 /* Function: operator int()
simon.ford@mbed.co.uk 0:82220227f4fa 53 * A shorthand for <read>
simon.ford@mbed.co.uk 0:82220227f4fa 54 */
simon.ford@mbed.co.uk 0:82220227f4fa 55 operator int();
simon.ford@mbed.co.uk 0:82220227f4fa 56
simon.ford@mbed.co.uk 0:82220227f4fa 57 protected:
simon.ford@mbed.co.uk 0:82220227f4fa 58
simon.ford@mbed.co.uk 0:82220227f4fa 59 LPC2300::GPIORF* _rf;
simon.ford@mbed.co.uk 0:82220227f4fa 60 unsigned int _mask;
simon.ford@mbed.co.uk 0:82220227f4fa 61 int _id;
simon.ford@mbed.co.uk 0:82220227f4fa 62
simon.ford@mbed.co.uk 0:82220227f4fa 63 };
simon.ford@mbed.co.uk 0:82220227f4fa 64
simon.ford@mbed.co.uk 0:82220227f4fa 65 }
simon.ford@mbed.co.uk 0:82220227f4fa 66
simon.ford@mbed.co.uk 1:6b7f447ca868 67 #endif
simon.ford@mbed.co.uk 1:6b7f447ca868 68