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:

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...
BusOut &	operator= (int v)
	A shorthand for write() More...
DigitalOut &	operator[] (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 33 of file BusOut.h.

Constructor & Destructor Documentation

BusOut() [1/2]

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

p0	DigitalOut pin to connect to bus bit
p1	DigitalOut pin to connect to bus bit
p2	DigitalOut pin to connect to bus bit
p3	DigitalOut pin to connect to bus bit
p4	DigitalOut pin to connect to bus bit
p5	DigitalOut pin to connect to bus bit
p6	DigitalOut pin to connect to bus bit
p7	DigitalOut pin to connect to bus bit
p8	DigitalOut pin to connect to bus bit
p9	DigitalOut pin to connect to bus bit
p10	DigitalOut pin to connect to bus bit
p11	DigitalOut pin to connect to bus bit
p12	DigitalOut pin to connect to bus bit
p13	DigitalOut pin to connect to bus bit
p14	DigitalOut pin to connect to bus bit
p15	DigitalOut 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() [2/2]

BusOut

(

PinName

pins[16]

)

Create an BusOut, connected to the specified pins.

Parameters

pins	An array of pins to connect to bus the bit

Member Function Documentation

write()

void write

(

int

value

)

Write the value to the output bus.

Parameters

value

An integer specifying a bit to write for every corresponding DigitalOut pin

read()

int read

(

)

Read the value currently output on the bus.

Returns

An integer with each bit corresponding to associated DigitalOut pin setting

mask()

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 BusOut.h.

operator=()

BusOut & operator=

(

int

v

)

A shorthand for write()

See also

BusOut::write()

operator[]()

DigitalOut & operator[]

(

int

index

)

Access to particular bit in random-iterator fashion.

Parameters

index

Bit Position

operator int()

operator int

(

)

A shorthand for read()

See also

BusOut::read()