Fork of the official mbed C/C++ SDK provides the software platform and libraries to build your applications. The fork has the documentation converted to Doxygen format

Dependents:   NervousPuppySprintOne NervousPuppySprint2602 Robot WarehouseBot1 ... more

Fork of mbed by mbed official

Embed: (wiki syntax)

« Back to documentation index

PortOut Class Reference

PortOut Class Reference

A multiple pin digital out. More...

#include <PortOut.h>

Public Member Functions

 PortOut (PortName port, int mask=0xFFFFFFFF)
 Create an 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()
 operator int ()
 A shorthand for read()

Detailed Description

A multiple pin digital out.

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 42 of file PortOut.h.


Constructor & Destructor Documentation

PortOut ( PortName  port,
int  mask = 0xFFFFFFFF 
)

Create an PortOut, connected to the specified port.

Parameters:
portPort to connect to (Port0-Port5)
maskA bitmask to identify which bits in the port should be included (0 - ignore)

Member Function Documentation

operator int (  )

A shorthand for read()

Definition at line 79 of file PortOut.h.

PortOut& operator= ( int  value )

A shorthand for write()

Definition at line 67 of file PortOut.h.

int read (  )

Read the value currently output on the port.

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

Write the value to the output port.

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