Matthew Sims / mbed

Lab 1 Program C

Dependents:   Lab1C

Fork of mbed by -deleted-

BusIn.h@43:aff670d0d510, 2012-10-24 (annotated)

Committer:
screamer
Date:
Wed Oct 24 10:44:49 2012 +0000
Revision:
43:aff670d0d510
Parent:
27:7110ebee3484 
Conversion of the classes documentation to Doxygen format

Who changed what in which revision?

UserRevisionLine numberNew contents of line
rolf.meyer@arm.com 11:1c1ebd0324fa 1 /* mbed Microcontroller Library - DigitalIn
rolf.meyer@arm.com 11:1c1ebd0324fa 2 * Copyright (c) 2007-2009 ARM Limited. All rights reserved.
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_BUSIN_H
simon.ford@mbed.co.uk 0:82220227f4fa 6 #define MBED_BUSIN_H
simon.ford@mbed.co.uk 0:82220227f4fa 7
rolf.meyer@arm.com 11:1c1ebd0324fa 8 #include "platform.h"
rolf.meyer@arm.com 11:1c1ebd0324fa 9 #include "PinNames.h"
rolf.meyer@arm.com 11:1c1ebd0324fa 10 #include "PeripheralNames.h"
simon.ford@mbed.co.uk 0:82220227f4fa 11 #include "Base.h"
simon.ford@mbed.co.uk 0:82220227f4fa 12 #include "DigitalIn.h"
simon.ford@mbed.co.uk 0:82220227f4fa 13
simon.ford@mbed.co.uk 0:82220227f4fa 14 namespace mbed {
simon.ford@mbed.co.uk 0:82220227f4fa 15
screamer 43:aff670d0d510 16 /** A digital input bus, used for reading the state of a collection of pins
simon.ford@mbed.co.uk 0:82220227f4fa 17 */
simon.ford@mbed.co.uk 0:82220227f4fa 18 class BusIn : public Base {
simon.ford@mbed.co.uk 0:82220227f4fa 19
simon.ford@mbed.co.uk 0:82220227f4fa 20 public:
simon.ford@mbed.co.uk 0:82220227f4fa 21
screamer 43:aff670d0d510 22 /** Create an BusIn, connected to the specified pins
rolf.meyer@arm.com 11:1c1ebd0324fa 23 *
screamer 43:aff670d0d510 24 * @param <n> DigitalIn pin to connect to bus bit <n> (p5-p30, NC)
simon.ford@mbed.co.uk 0:82220227f4fa 25 *
screamer 43:aff670d0d510 26 * @note
simon.ford@mbed.co.uk 0:82220227f4fa 27 * It is only required to specify as many pin variables as is required
rolf.meyer@arm.com 11:1c1ebd0324fa 28 * for the bus; the rest will default to NC (not connected)
rolf.meyer@arm.com 11:1c1ebd0324fa 29 */
rolf.meyer@arm.com 11:1c1ebd0324fa 30 BusIn(PinName p0, PinName p1 = NC, PinName p2 = NC, PinName p3 = NC,
rolf.meyer@arm.com 11:1c1ebd0324fa 31 PinName p4 = NC, PinName p5 = NC, PinName p6 = NC, PinName p7 = NC,
rolf.meyer@arm.com 11:1c1ebd0324fa 32 PinName p8 = NC, PinName p9 = NC, PinName p10 = NC, PinName p11 = NC,
rolf.meyer@arm.com 11:1c1ebd0324fa 33 PinName p12 = NC, PinName p13 = NC, PinName p14 = NC, PinName p15 = NC,
simon.ford@mbed.co.uk 4:5d1359a283bc 34 const char *name = NULL);
simon.ford@mbed.co.uk 5:62573be585e9 35
rolf.meyer@arm.com 11:1c1ebd0324fa 36 BusIn(PinName pins[16], const char *name = NULL);
screamer 43:aff670d0d510 37
screamer 43:aff670d0d510 38 virtual ~BusIn();
screamer 43:aff670d0d510 39
screamer 43:aff670d0d510 40 /** Read the value of the input bus
screamer 43:aff670d0d510 41 *
screamer 43:aff670d0d510 42 * @returns
screamer 43:aff670d0d510 43 * An integer with each bit corresponding to the value read from the associated DigitalIn pin
screamer 43:aff670d0d510 44 */
simon.ford@mbed.co.uk 0:82220227f4fa 45 int read();
rolf.meyer@arm.com 11:1c1ebd0324fa 46
rolf.meyer@arm.com 11:1c1ebd0324fa 47 #ifdef MBED_OPERATORS
screamer 43:aff670d0d510 48 /** A shorthand for read()
rolf.meyer@arm.com 11:1c1ebd0324fa 49 */
rolf.meyer@arm.com 11:1c1ebd0324fa 50 operator int();
rolf.meyer@arm.com 11:1c1ebd0324fa 51 #endif
simon.ford@mbed.co.uk 4:5d1359a283bc 52
rolf.meyer@arm.com 11:1c1ebd0324fa 53 #ifdef MBED_RPC
simon.ford@mbed.co.uk 5:62573be585e9 54 virtual const struct rpc_method *get_rpc_methods();
simon.ford@mbed.co.uk 5:62573be585e9 55 static struct rpc_class *get_rpc_class();
rolf.meyer@arm.com 11:1c1ebd0324fa 56 #endif
simon.ford@mbed.co.uk 5:62573be585e9 57
simon.ford@mbed.co.uk 0:82220227f4fa 58 protected:
screamer 43:aff670d0d510 59
rolf.meyer@arm.com 11:1c1ebd0324fa 60 DigitalIn* _pin[16];
simon.ford@mbed.co.uk 5:62573be585e9 61
rolf.meyer@arm.com 11:1c1ebd0324fa 62 #ifdef MBED_RPC
rolf.meyer@arm.com 11:1c1ebd0324fa 63 static void construct(const char *arguments, char *res);
rolf.meyer@arm.com 11:1c1ebd0324fa 64 #endif
rolf.meyer@arm.com 11:1c1ebd0324fa 65
simon.ford@mbed.co.uk 0:82220227f4fa 66 };
simon.ford@mbed.co.uk 0:82220227f4fa 67
rolf.meyer@arm.com 11:1c1ebd0324fa 68 } // namespace mbed
simon.ford@mbed.co.uk 0:82220227f4fa 69
simon.ford@mbed.co.uk 1:6b7f447ca868 70 #endif
simon.ford@mbed.co.uk 1:6b7f447ca868 71