Ashley Mills / ATConsole

Dependencies:   mbed-rtos VodafoneUSBModem mbed

Embed: (wiki syntax)

« Back to documentation index

Console Class Reference

Console Class Reference

Console interface with line editing and command history. More...

#include <Console.h>

Inherited by ATConsole.

Public Member Functions

 Console (Serial *terminal, int lineLength, int numLines, bool characterBased)
 Construct an interface to a serial terminal.
virtual void update ()
 This is called by the instantiating program to update the console.

Protected Attributes

bool _characterBased
 Whether or not this console is character based (true) or line based (false).

Detailed Description

Console interface with line editing and command history.

Definition at line 27 of file Console.h.


Constructor & Destructor Documentation

Console ( Serial *  terminal,
int  lineLength,
int  numLines,
bool  characterBased 
)

Construct an interface to a serial terminal.

Parameters:
terminalThe serial device to interface to.
lineLengthThe maximum line-length to process.
numLinesThe number of lines to hold in the command-history.
characterBasedtrue for character based serial devices, false for line based.

Definition at line 4 of file Console.cpp.


Member Function Documentation

void update (  ) [virtual]

This is called by the instantiating program to update the console.

Reimplemented in ATConsole.

Definition at line 307 of file Console.cpp.


Field Documentation

bool _characterBased [protected]

Whether or not this console is character based (true) or line based (false).

Definition at line 49 of file Console.h.