Kenji Arai / mbed-os_TYBLE16

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependents:   TYBLE16_simple_data_logger TYBLE16_MP3_Air

Embed: (wiki syntax)

« Back to documentation index

BusInOut Class Reference
Public Member Functions | Private Member Functions

BusInOut Class Reference
[BusInOut class]

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

#include <BusInOut.h>

Inherits NonCopyable< BusInOut >.

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 a BusInOut, connected to the specified pins.
 BusInOut (PinName pins[16])
 Create a 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 all the pins in bus as output.
void input ()
 Set all the pins in bus as an input.
void mode (PinMode pull)
 Set the input pin mode for all the pins in bus.
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.
BusInOut & operator= (int v)
 A shorthand for write()
DigitalInOut & operator[] (int index)
 Access to particular bit in random-iterator fashion.
 operator int ()
 A shorthand for read()

Private Member Functions

 MBED_DEPRECATED ("Invalid copy construction of a NonCopyable resource.") NonCopyable(const NonCopyable &)
 NonCopyable copy constructor.
 MBED_DEPRECATED ("Invalid copy assignment of a NonCopyable resource.") NonCopyable &operator
 NonCopyable copy assignment operator.

Detailed Description

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

Implemented as an array of DigitalInOut pins, the bus can be constructed by any pins without restriction other than being capable of digital input or output capabilities

Note:
Synchronization level: Thread safe

Definition at line 38 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 a BusInOut, connected to the specified pins.

Parameters:
p0DigitalInOut pin to connect to bus bit
p1DigitalInOut pin to connect to bus bit
p2DigitalInOut pin to connect to bus bit
p3DigitalInOut pin to connect to bus bit
p4DigitalInOut pin to connect to bus bit
p5DigitalInOut pin to connect to bus bit
p6DigitalInOut pin to connect to bus bit
p7DigitalInOut pin to connect to bus bit
p8DigitalInOut pin to connect to bus bit
p9DigitalInOut pin to connect to bus bit
p10DigitalInOut pin to connect to bus bit
p11DigitalInOut pin to connect to bus bit
p12DigitalInOut pin to connect to bus bit
p13DigitalInOut pin to connect to bus bit
p14DigitalInOut pin to connect to bus bit
p15DigitalInOut pin to connect to bus bit
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 22 of file BusInOut.cpp.

BusInOut ( PinName  pins[16] )

Create a BusInOut, connected to the specified pins.

Parameters:
pinsAn array of pins (PinName) to construct a BusInOut from. The maximum number of pins in the array is 16 and any pins that are unspecified or are not to be connected must be specified as NC in the array that is passed in

Definition at line 36 of file BusInOut.cpp.

Member Function Documentation

void input (  )

Set all the pins in bus as an input.

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

void mode ( PinMode  pull )

Set the input pin mode for all the pins in bus.

Parameters:
pullPullUp, PullDown, PullNone

Definition at line 104 of file BusInOut.cpp.

operator int (  )

A shorthand for read()

See also:
BusInOut::read()

Definition at line 137 of file BusInOut.cpp.

BusInOut & operator= ( int  v )

A shorthand for write()

See also:
BusInOut::write()

Definition at line 115 of file BusInOut.cpp.

DigitalInOut & operator[] ( int  index )

Access to particular bit in random-iterator fashion.

Parameters:
indexBit Position

Definition at line 129 of file BusInOut.cpp.

void output (  )

Set all the pins in bus as output.

Definition at line 82 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 69 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 58 of file BusInOut.cpp.

Generated on Tue Jul 12 2022 13:55:42 by  doxygen 1.7.2