XBee API operation library for mbed

Embed: (wiki syntax)

« Back to documentation index

Pin Class Reference

Base class for XBee module pin configuration. More...

#include <Pin.h>

Public Member Functions

 Pin (unsigned char number)
 Create a pin with its number, using this constructor means this pin has no IO functions.
 Pin (unsigned char number, const char *command, unsigned int changeDetection)
 Create a pin with its number, using this constructor means this pin has IO functions.
const char * getCommand ()
 Get the configuration command.
const unsigned char * getIODetection ()
 Get the IO change detection bitmask for this pin.

Static Public Member Functions

static const unsigned char * IOChangeDetectionConfiguration (Pin **pins, unsigned char size)
 Get the IO change detection bitmask for a set of pins.

Friends

bool operator== (const Pin &a, const Pin &b)
 Compare two pin and check if both are the same.
bool operator!= (const Pin &a, const Pin &b)
 Compare two pin and check if both are the same.

Detailed Description

Base class for XBee module pin configuration.

Definition at line 5 of file Pin.h.


Constructor & Destructor Documentation

Pin ( unsigned char  number )

Create a pin with its number, using this constructor means this pin has no IO functions.

Parameters:
numberthe number of the pin (0 - 20)

Definition at line 5 of file Pin.cpp.

Pin ( unsigned char  number,
const char *  command,
unsigned int  changeDetection 
)

Create a pin with its number, using this constructor means this pin has IO functions.

Parameters:
numberthe number of the pin (0 - 20)
commandthe configure command for the pin (eg. 'D0')
changeDetectionIO change dection bitmask configuration.

Definition at line 10 of file Pin.cpp.


Member Function Documentation

const char * getCommand (  )

Get the configuration command.

Definition at line 24 of file Pin.cpp.

const unsigned char * getIODetection (  )

Get the IO change detection bitmask for this pin.

Definition at line 40 of file Pin.cpp.

const unsigned char * IOChangeDetectionConfiguration ( Pin **  pins,
unsigned char  size 
) [static]

Get the IO change detection bitmask for a set of pins.

Definition at line 29 of file Pin.cpp.


Friends And Related Function Documentation

bool operator!= ( const Pin a,
const Pin b 
) [friend]

Compare two pin and check if both are the same.

Definition at line 50 of file Pin.cpp.

bool operator== ( const Pin a,
const Pin b 
) [friend]

Compare two pin and check if both are the same.

Definition at line 45 of file Pin.cpp.