Rtos API example
BusInOut Class Reference
[Drivers]
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 an BusInOut, connected to the specified pins. | |
BusInOut (PinName pins[16]) | |
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. | |
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.
- Note:
- Synchronization level: Thread safe
Definition at line 31 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:
-
p0 DigitalInOut pin to connect to bus bit p1 DigitalInOut pin to connect to bus bit p2 DigitalInOut pin to connect to bus bit p3 DigitalInOut pin to connect to bus bit p4 DigitalInOut pin to connect to bus bit p5 DigitalInOut pin to connect to bus bit p6 DigitalInOut pin to connect to bus bit p7 DigitalInOut pin to connect to bus bit p8 DigitalInOut pin to connect to bus bit p9 DigitalInOut pin to connect to bus bit p10 DigitalInOut pin to connect to bus bit p11 DigitalInOut pin to connect to bus bit p12 DigitalInOut pin to connect to bus bit p13 DigitalInOut pin to connect to bus bit p14 DigitalInOut pin to connect to bus bit p15 DigitalInOut 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 21 of file BusInOut.cpp.
BusInOut | ( | PinName | pins[16] ) |
Create an BusInOut, connected to the specified pins.
- Parameters:
-
pins An array of pins to construct a BusInOut from
Definition at line 34 of file BusInOut.cpp.
Member Function Documentation
void input | ( | ) |
Set as an input.
Definition at line 86 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 106 of file BusInOut.h.
void mode | ( | PinMode | pull ) |
Set the input pin mode.
- Parameters:
-
pull PullUp, PullDown, PullNone
Definition at line 96 of file BusInOut.cpp.
operator int | ( | ) |
BusInOut & operator= | ( | int | v ) |
DigitalInOut & operator[] | ( | int | index ) |
Access to particular bit in random-iterator fashion.
- Parameters:
-
index Bit Position
Definition at line 118 of file BusInOut.cpp.
void output | ( | ) |
Set as an output.
Definition at line 76 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 64 of file BusInOut.cpp.
void write | ( | int | value ) |
Write the value to the output bus.
- Parameters:
-
value An integer specifying a bit to write for every corresponding DigitalInOut pin
Definition at line 54 of file BusInOut.cpp.
Generated on Sun Jul 17 2022 08:25:43 by 1.7.2