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

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. More...
 
void write (int value)
 Write the value to the output port. More...
 
int read ()
 Read the value currently output on the port. More...
 
PortOutoperator= (int value)
 A shorthand for write() More...
 
PortOutoperator= (PortOut &rhs)
 A shorthand for read() More...
 
 operator int ()
 A shorthand for read() More...
 

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;
ThisThread::sleep_for(1000);
ledport = 0;
ThisThread::sleep_for(1000);
}
}

Definition at line 58 of file 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)

Member Function Documentation

operator int ( )

A shorthand for read()

See also
PortOut::read()

Definition at line 108 of file PortOut.h.

PortOut& operator= ( int  value)

A shorthand for write()

See also
PortOut::write()

Definition at line 90 of file PortOut.h.

PortOut& operator= ( PortOut rhs)

A shorthand for read()

See also
PortOut::read()

Definition at line 99 of file 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 82 of file 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 72 of file PortOut.h.

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.