mbed official / mbed-dev

mbed library sources. Supersedes mbed-src.

Dependents:   Nucleo_Hello_Encoder BLE_iBeaconScan AM1805_DEMO DISCO-F429ZI_ExportTemplate1 ... more

Embed: (wiki syntax)

« Back to documentation index

BusIn Class Reference
Public Member Functions | Private Member Functions

BusIn Class Reference
[Drivers]

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

#include <BusIn.h>

Inherits NonCopyable< BusIn >, and NonCopyable< BusIn >.

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.
 BusIn (PinName pins[16])
 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()
DigitalIn & operator[] (int index)
 Access to particular bit in random-iterator fashion.
 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.
 BusIn (PinName pins[16])
 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()
DigitalIn & operator[] (int index)
 Access to particular bit in random-iterator fashion.

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

Note:
Synchronization level: Thread safe

Definition at line 33 of file cmsis/BUILD/mbed/drivers/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:
p0DigitalIn pin to connect to bus bit
p1DigitalIn pin to connect to bus bit
p2DigitalIn pin to connect to bus bit
p3DigitalIn pin to connect to bus bit
p4DigitalIn pin to connect to bus bit
p5DigitalIn pin to connect to bus bit
p6DigitalIn pin to connect to bus bit
p7DigitalIn pin to connect to bus bit
p8DigitalIn pin to connect to bus bit
p9DigitalIn pin to connect to bus bit
p10DigitalIn pin to connect to bus bit
p11DigitalIn pin to connect to bus bit
p12DigitalIn pin to connect to bus bit
p13DigitalIn pin to connect to bus bit
p14DigitalIn pin to connect to bus bit
p15DigitalIn 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 BusIn.cpp.

BusIn ( PinName  pins[16] )

Create an BusIn, connected to the specified pins.

Parameters:
pinsAn array of pins to connect to bus bit

Definition at line 36 of file BusIn.cpp.

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:
p0DigitalIn pin to connect to bus bit
p1DigitalIn pin to connect to bus bit
p2DigitalIn pin to connect to bus bit
p3DigitalIn pin to connect to bus bit
p4DigitalIn pin to connect to bus bit
p5DigitalIn pin to connect to bus bit
p6DigitalIn pin to connect to bus bit
p7DigitalIn pin to connect to bus bit
p8DigitalIn pin to connect to bus bit
p9DigitalIn pin to connect to bus bit
p10DigitalIn pin to connect to bus bit
p11DigitalIn pin to connect to bus bit
p12DigitalIn pin to connect to bus bit
p13DigitalIn pin to connect to bus bit
p14DigitalIn pin to connect to bus bit
p15DigitalIn 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)
BusIn ( PinName  pins[16] )

Create an BusIn, connected to the specified pins.

Parameters:
pinsAn array of pins to connect to bus bit

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 94 of file cmsis/BUILD/mbed/drivers/BusIn.h.

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 94 of file drivers/BusIn.h.

void mode ( PinMode  pull )

Set the input pin mode.

Parameters:
pullPullUp, PullDown, PullNone

Definition at line 71 of file BusIn.cpp.

void mode ( PinMode  pull )

Set the input pin mode.

Parameters:
pullPullUp, PullDown, PullNone
operator int (  )

A shorthand for read()

See also:
DigitalIn::read()

Definition at line 92 of file BusIn.cpp.

operator int (  )

A shorthand for read()

See also:
DigitalIn::read()
DigitalIn & operator[] ( int  index )

Access to particular bit in random-iterator fashion.

Parameters:
indexPosition of bit

Definition at line 98 of file BusIn.cpp.

DigitalIn& operator[] ( int  index )

Access to particular bit in random-iterator fashion.

Parameters:
indexPosition of bit
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 58 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
Generated on Tue Jul 12 2022 20:41:17 by  doxygen 1.7.2