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

PortOut Class Reference

PortOut Class Reference
[Drivers]

A multiple pin digital output. More...

#include <PortOut.h>

Public Member Functions

 PortOut (PortName port, int mask=0xFFFFFFFF)
 Create a PortOut, connected to the specified port.
void write (int value)
 Write the value to the output port.
int read ()
 Read the value currently output on the port.
PortOutoperator= (int value)
 A shorthand for write()
PortOutoperator= (PortOut &rhs)
 A shorthand for read()
 operator int ()
 A shorthand for read()
 PortOut (PortName port, int mask=0xFFFFFFFF)
 Create a PortOut, connected to the specified port.
void write (int value)
 Write the value to the output port.
int read ()
 Read the value currently output on the port.
PortOutoperator= (int value)
 A shorthand for write()
PortOutoperator= (PortOut &rhs)
 A shorthand for read()
 operator int ()
 A shorthand for read()

Detailed Description

A multiple pin digital output.

Note:
Synchronization level: Interrupt safe

Example:

 // Toggle all four LEDs

 #include "mbed.h"

 // LED1 = P1.18  LED2 = P1.20  LED3 = P1.21  LED4 = P1.23
 #define LED_MASK 0x00B40000

 PortOut ledport(Port1, LED_MASK);

 int main() {
     while(1) {
         ledport = LED_MASK;
         wait(1);
         ledport = 0;
         wait(1);
     }
 }

Definition at line 55 of file cmsis/BUILD/mbed/drivers/PortOut.h.


Constructor & Destructor Documentation

PortOut ( PortName  port,
int  mask = 0xFFFFFFFF 
)

Create a PortOut, connected to the specified port.

Parameters:
portPort to connect to (as defined in target's PortNames.h)
maskBitmask defines which port pins are an output (0 - ignore, 1 - include)

Definition at line 63 of file cmsis/BUILD/mbed/drivers/PortOut.h.

PortOut ( PortName  port,
int  mask = 0xFFFFFFFF 
)

Create a PortOut, connected to the specified port.

Parameters:
portPort to connect to (as defined in target's PortNames.h)
maskBitmask defines which port pins are an output (0 - ignore, 1 - include)

Definition at line 63 of file drivers/PortOut.h.


Member Function Documentation

operator int (  )

A shorthand for read()

See also:
PortOut::read()

Definition at line 110 of file cmsis/BUILD/mbed/drivers/PortOut.h.

operator int (  )

A shorthand for read()

See also:
PortOut::read()

Definition at line 110 of file drivers/PortOut.h.

PortOut& operator= ( PortOut rhs )

A shorthand for read()

See also:
PortOut::read()

Definition at line 101 of file drivers/PortOut.h.

PortOut& operator= ( PortOut rhs )

A shorthand for read()

See also:
PortOut::read()

Definition at line 101 of file cmsis/BUILD/mbed/drivers/PortOut.h.

PortOut& operator= ( int  value )

A shorthand for write()

See also:
PortOut::write()

Definition at line 92 of file drivers/PortOut.h.

PortOut& operator= ( int  value )

A shorthand for write()

See also:
PortOut::write()

Definition at line 92 of file cmsis/BUILD/mbed/drivers/PortOut.h.

int read ( void   )

Read the value currently output on the port.

Returns:
An integer with each bit corresponding to associated pin value

Definition at line 84 of file drivers/PortOut.h.

int read ( void   )

Read the value currently output on the port.

Returns:
An integer with each bit corresponding to associated pin value

Definition at line 84 of file cmsis/BUILD/mbed/drivers/PortOut.h.

void write ( int  value )

Write the value to the output port.

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

Definition at line 74 of file cmsis/BUILD/mbed/drivers/PortOut.h.

void write ( int  value )

Write the value to the output port.

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

Definition at line 74 of file drivers/PortOut.h.