A library that maps the functions used with the mbed microcontroller to be used on with the GPIO ports of a Raspberry pi.

Embed: (wiki syntax)

« Back to documentation index

BusOut Class Reference

BusOut Class Reference

A BusOut interface is used to create several DigitalOut pins that can be written to using only one value. More...

#include <BusOut.h>

Inherits CPPToPigpio::CPPToPigpio.

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 (int p0, int p1=-1, int p2=-1, int p3=-1, int p4=-1, int p5=-1, int p6=-1, int p7=-1, int p8=-1, int p9=-1, int p10=-1, int p11=-1, int p12=-1, int p13=-1, int p14=-1, int p15=-1)
 Create an BusOut, connected to the specified pins.
 BusOut (int busSize, PinName pinNames[16])
 Creates a BusOut, connected to the specific pins.
 BusOut (int busSize, int pinNames[16])
 Creates a BusOut, connected to the specific pins.
void write (int value)
 Write the value to the output bus.
int read ()
 Read the value currently output on the bus.
 operator int ()
 A shorthand for read()
DigitalOutoperator[] (int index)
 Access to particular bit in random-iterator fashion.
BusOutoperator= (int v)
 A shorthand for write()
long long 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 ()
 Desconstructor for object.

Detailed Description

A BusOut interface is used to create several DigitalOut pins that can be written to using only one value.

Definition at line 10 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

Definition at line 4 of file BusOut.cc.

BusOut ( int  p0,
int  p1 = -1,
int  p2 = -1,
int  p3 = -1,
int  p4 = -1,
int  p5 = -1,
int  p6 = -1,
int  p7 = -1,
int  p8 = -1,
int  p9 = -1,
int  p10 = -1,
int  p11 = -1,
int  p12 = -1,
int  p13 = -1,
int  p14 = -1,
int  p15 = -1 
)

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

Definition at line 47 of file BusOut.cc.

BusOut ( int  busSize,
PinName  pinNames[16] 
)

Creates a BusOut, connected to the specific pins.

Parameters:
numberof pins specified
arrayof pins to connect to bus

Definition at line 92 of file BusOut.cc.

BusOut ( int  busSize,
int  pinNames[16] 
)

Creates a BusOut, connected to the specific pins.

Parameters:
numberof pins specified
arrayof pins to connect to bus

Definition at line 103 of file BusOut.cc.

~BusOut (  )

Desconstructor for object.

Definition at line 160 of file BusOut.cc.


Member Function Documentation

long long 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 149 of file BusOut.cc.

operator int (  )

A shorthand for read()

See also:
BusOut::read()

Definition at line 131 of file BusOut.cc.

BusOut & operator= ( int  v )

A shorthand for write()

See also:
BusOut::write()

Definition at line 141 of file BusOut.cc.

DigitalOut & operator[] ( int  index )

Access to particular bit in random-iterator fashion.

Parameters:
indexBit Position

Definition at line 136 of file BusOut.cc.

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 126 of file BusOut.cc.

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 115 of file BusOut.cc.