Mistake on this page?
Report an issue in GitHub or email us
Public Member Functions
BusOut Class Reference

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

#include <BusOut.h>

Inheritance diagram for BusOut:
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. More...
 
 BusOut (PinName pins[16])
 Create an BusOut, connected to the specified pins. More...
 
void write (int value)
 Write the value to the output bus. More...
 
int read ()
 Read the value currently output on the bus. More...
 
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. More...
 
BusOutoperator= (int v)
 A shorthand for write() More...
 
DigitalOutoperator[] (int index)
 Access to particular bit in random-iterator fashion. More...
 
 operator int ()
 A shorthand for read() More...
 

Detailed Description

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

Definition at line 30 of file 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)
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 BusOut.h.

operator int ( )

A shorthand for read()

See also
BusOut::read()
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
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
Important Information for this Arm website

This site uses cookies to store information on your computer. By continuing to use our site, you consent to our cookies. If you are not happy with the use of these cookies, please review our Cookie Policy to learn how they can be disabled. By disabling cookies, some features of the site will not work.