mbed library for NZ32-SC151

Embed: (wiki syntax)

« Back to documentation index

BusInOut Class Reference

BusInOut Class Reference

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

#include <BusInOut.h>

Public Member Functions

 BusInOut (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 BusInOut, connected to the specified pins.
void write (int value)
 Write the value to the output bus.
int read ()
 Read the value currently output on the bus.
void output ()
 Set as an output.
void input ()
 Set as an input.
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.
BusInOutoperator= (int v)
 A shorthand for write()
DigitalInOutoperator[] (int index)
 Access to particular bit in random-iterator fashion.
 operator int ()
 A shorthand for read()

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 output bus, used for setting the state of a collection of pins.

Definition at line 25 of file BusInOut.h.


Constructor & Destructor Documentation

BusInOut ( 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 BusInOut, connected to the specified pins.

Parameters:
p<n>DigitalInOut pin to connect to bus bit p<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 BusInOut.cpp.


Member Function Documentation

void input (  )

Set as an input.

Definition at line 77 of file BusInOut.cpp.

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 81 of file BusInOut.h.

void mode ( PinMode  pull )

Set the input pin mode.

Parameters:
modePullUp, PullDown, PullNone

Definition at line 85 of file BusInOut.cpp.

operator int (  )

A shorthand for read()

Definition at line 110 of file BusInOut.cpp.

BusInOut & operator= ( int  v )

A shorthand for write()

Definition at line 94 of file BusInOut.cpp.

DigitalInOut & operator[] ( int  index )

Access to particular bit in random-iterator fashion.

Definition at line 104 of file BusInOut.cpp.

void output (  )

Set as an output.

Definition at line 69 of file BusInOut.cpp.

int read (  )

Read the value currently output on the bus.

Returns:
An integer with each bit corresponding to associated DigitalInOut pin setting

Definition at line 59 of file BusInOut.cpp.

void write ( int  value )

Write the value to the output bus.

Parameters:
valueAn integer specifying a bit to write for every corresponding DigitalInOut pin

Definition at line 51 of file BusInOut.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 107 of file BusInOut.h.