mbed library sources

Dependents:   RPC_Serial_V_mac

Embed: (wiki syntax)

« Back to documentation index

BusIn Class Reference

A digital input bus, used for reading the state of a collection of pins. More...

#include <BusIn.h>

Public Member Functions

 BusIn (PinName p0, PinName p1=NC, PinName p2=NC, PinName p3=NC, PinName p4=NC, PinName p5=NC, PinName p6=NC, PinName p7=NC, PinName p8=NC, PinName p9=NC, PinName p10=NC, PinName p11=NC, PinName p12=NC, PinName p13=NC, PinName p14=NC, PinName p15=NC)
 Create an BusIn, connected to the specified pins.
int read ()
 Read the value of the input bus.
void mode (PinMode pull)
 Set the input pin mode.
int mask ()
 Binary mask of bus pins connected to actual pins (not NC pins) If bus pin is in NC state make corresponding bit will be cleared (set to 0), else bit will be set to 1.
 operator int ()
 A shorthand for read()
DigitalInoperator[] (int index)
 Access to particular bit in random-iterator fashion.

Protected Attributes

int _nc_mask
 Mask of bus's NC pins If bit[n] is set to 1 - pin is connected if bit[n] is cleared - pin is not connected (NC)

Detailed Description

A digital input bus, used for reading the state of a collection of pins.

Definition at line 26 of file BusIn.h.


Constructor & Destructor Documentation

BusIn ( PinName  p0,
PinName  p1 = NC,
PinName  p2 = NC,
PinName  p3 = NC,
PinName  p4 = NC,
PinName  p5 = NC,
PinName  p6 = NC,
PinName  p7 = NC,
PinName  p8 = NC,
PinName  p9 = NC,
PinName  p10 = NC,
PinName  p11 = NC,
PinName  p12 = NC,
PinName  p13 = NC,
PinName  p14 = NC,
PinName  p15 = NC 
)

Create an BusIn, connected to the specified pins.

Parameters:
<n>DigitalIn pin to connect to bus bit <n> (p5-p30, NC)
Note:
It is only required to specify as many pin variables as is required for the bus; the rest will default to NC (not connected)

Definition at line 21 of file BusIn.cpp.


Member Function Documentation

int mask (  )

Binary mask of bus pins connected to actual pins (not NC pins) If bus pin is in NC state make corresponding bit will be cleared (set to 0), else bit will be set to 1.

Returns:
Binary mask of connected pins

Definition at line 67 of file BusIn.h.

void mode ( PinMode  pull )

Set the input pin mode.

Parameters:
modePullUp, PullDown, PullNone

Definition at line 61 of file BusIn.cpp.

operator int (  )

A shorthand for read()

Definition at line 70 of file BusIn.cpp.

DigitalIn & operator[] ( int  index )

Access to particular bit in random-iterator fashion.

Definition at line 74 of file BusIn.cpp.

int read (  )

Read the value of the input bus.

Returns:
An integer with each bit corresponding to the value read from the associated DigitalIn pin

Definition at line 51 of file BusIn.cpp.


Field Documentation

int _nc_mask [protected]

Mask of bus's NC pins If bit[n] is set to 1 - pin is connected if bit[n] is cleared - pin is not connected (NC)

Definition at line 88 of file BusIn.h.