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

BusOut Class Reference
Public Member Functions | Private Member Functions

BusOut Class Reference
[Drivers]

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

#include <BusOut.h>

Inherits NonCopyable< BusOut >, and NonCopyable< BusOut >.

Public Member Functions

 BusOut (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 BusOut, connected to the specified pins.
 BusOut (PinName pins[16])
 Create an BusOut, 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.
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.
BusOut & operator= (int v)
 A shorthand for write()
DigitalOut & operator[] (int index)
 Access to particular bit in random-iterator fashion.
 operator int ()
 A shorthand for read()
 BusOut (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 BusOut, connected to the specified pins.
 BusOut (PinName pins[16])
 Create an BusOut, 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.
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.
BusOut & operator= (int v)
 A shorthand for write()
DigitalOut & 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.
 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 output bus, used for setting the state of a collection of pins.

Definition at line 30 of file cmsis/BUILD/mbed/drivers/BusOut.h.

Constructor & Destructor Documentation

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

Parameters:
p0DigitalOut pin to connect to bus bit
p1DigitalOut pin to connect to bus bit
p2DigitalOut pin to connect to bus bit
p3DigitalOut pin to connect to bus bit
p4DigitalOut pin to connect to bus bit
p5DigitalOut pin to connect to bus bit
p6DigitalOut pin to connect to bus bit
p7DigitalOut pin to connect to bus bit
p8DigitalOut pin to connect to bus bit
p9DigitalOut pin to connect to bus bit
p10DigitalOut pin to connect to bus bit
p11DigitalOut pin to connect to bus bit
p12DigitalOut pin to connect to bus bit
p13DigitalOut pin to connect to bus bit
p14DigitalOut pin to connect to bus bit
p15DigitalOut pin to connect to bus bit
Note:
Synchronization level: Thread safe
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 BusOut.cpp.

BusOut ( PinName  pins[16] )

Create an BusOut, connected to the specified pins.

Parameters:
pinsAn array of pins to connect to bus the bit

Definition at line 36 of file BusOut.cpp.

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

Parameters:
p0DigitalOut pin to connect to bus bit
p1DigitalOut pin to connect to bus bit
p2DigitalOut pin to connect to bus bit
p3DigitalOut pin to connect to bus bit
p4DigitalOut pin to connect to bus bit
p5DigitalOut pin to connect to bus bit
p6DigitalOut pin to connect to bus bit
p7DigitalOut pin to connect to bus bit
p8DigitalOut pin to connect to bus bit
p9DigitalOut pin to connect to bus bit
p10DigitalOut pin to connect to bus bit
p11DigitalOut pin to connect to bus bit
p12DigitalOut pin to connect to bus bit
p13DigitalOut pin to connect to bus bit
p14DigitalOut pin to connect to bus bit
p15DigitalOut pin to connect to bus bit
Note:
Synchronization level: Thread safe
It is only required to specify as many pin variables as is required for the bus; the rest will default to NC (not connected)
BusOut ( PinName  pins[16] )

Create an BusOut, connected to the specified pins.

Parameters:
pinsAn array of pins to connect to bus the 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 91 of file cmsis/BUILD/mbed/drivers/BusOut.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 91 of file drivers/BusOut.h.

operator int (  )

A shorthand for read()

See also:
BusOut::read()
operator int (  )

A shorthand for read()

See also:
BusOut::read()

Definition at line 104 of file BusOut.cpp.

BusOut & operator= ( int  v )

A shorthand for write()

See also:
BusOut::write()

Definition at line 82 of file BusOut.cpp.

BusOut& operator= ( int  v )

A shorthand for write()

See also:
BusOut::write()
DigitalOut& operator[] ( int  index )

Access to particular bit in random-iterator fashion.

Parameters:
indexBit Position
DigitalOut & operator[] ( int  index )

Access to particular bit in random-iterator fashion.

Parameters:
indexBit Position

Definition at line 96 of file BusOut.cpp.

int read (  )

Read the value currently output on the bus.

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

Definition at line 69 of file BusOut.cpp.

int read (  )

Read the value currently output on the bus.

Returns:
An integer with each bit corresponding to associated DigitalOut pin setting
void write ( int  value )

Write the value to the output bus.

Parameters:
valueAn integer specifying a bit to write for every corresponding DigitalOut pin
void write ( int  value )

Write the value to the output bus.

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

Definition at line 58 of file BusOut.cpp.

Generated on Tue Jul 12 2022 20:41:17 by  doxygen 1.7.2