The opt parameter
Many methods have the same parameter, opt, which is described
under the abendCode method inabendCode.
Returns an enumeration, defined in this class, that indicates which AID
(action identifier) key was last pressed at this terminal.
Returns the current cursor position as an offset from the top left corner
of the screen.
Returns a pointer to an IccTerminalData object that
contains information about the characteristics of the terminal. The object
is created if it does not already exist.
Erase all the data displayed at the terminal.
Conditions
Frees the keyboard so that the terminal can accept input.
Conditions
virtual const IccBuf& get()
unsigned short height(Icc::getopt opt = Icc::object)
Returns how many lines the screen holds.
Conditions
unsigned short inputCursor()
Returns the position of the cursor on the screen.
static IccTerminal* instance()
Returns a pointer to the single IccTerminal object.
The object is created if it does not already exist.
Returns the current line number of the cursor from the top of the screen.
Returns the 8-byte string representing the network logical unit name of
the principal facility.
IccTerminal& operator << (Color color)
Sets the foreground color for data subsequently sent to the terminal.
IccTerminal& operator << (Highlight highlight)
Sets the highlighting used for data subsequently sent to the terminal.
IccTerminal& operator << (const IccBuf& buffer)
Writes another buffer.
IccTerminal& operator << (char ch)
Writes a character.
IccTerminal& operator << (signed char ch)
Writes a character.
IccTerminal& operator << (unsigned char ch)
Writes a character.
IccTerminal& operator << (const char* text)
Writes a string.
IccTerminal& operator << (const signed char* text)
Writes a string.
IccTerminal& operator << (const unsigned char* text)
Writes a string.
IccTerminal& operator << (short num)
Writes a short.
IccTerminal& operator << (unsigned short num)
Writes an unsigned short.
IccTerminal& operator << (long num)
Writes a long.
IccTerminal& operator << (unsigned long num)
Writes an unsigned long.
IccTerminal& operator << (int num)
Writes an integer.
IccTerminal& operator << (float num)
Writes a float.
IccTerminal& operator << (double num)
Writes a double.
IccTerminal& operator << (long double num)
Writes a long double.
IccTerminal& operator << (IccTerminal& (*f)(IccTerminal&))
Enables the following syntax:
Term << "Hello World" << endl;
Term << "Hello again" << flush;
virtual void put(const IccBuf& buf)
A synonym for sendLine. See Polymorphic Behavior
for information on polymorphism.
const IccBuf& receive(Case caseOpt = upper)
- caseOpt
- An enumeration, defined in this class, that indicates whether text is
to be converted to upper case or left as it is.
Receives data from the terminal
Conditions
EOC, INVREQ, LENGERR, NOTALLOC, SIGNAL, TERMERR
const IccBuf& receive3270Data(Case caseOpt = upper)
- caseOpt
- An enumeration, defined in this class, that indicates whether text is
to be converted to upper case or left as it is.
Receives the 3270 data buffer from the terminal
Conditions
void send(const IccBuf& buffer)
- buffer
- A reference to an IccBuf object that holds the
data that is to be sent.
void send (const char* format,
...)
- format
- A format string, as in the printf standard library
function.
- ...
- The optional arguments that accompany format.
void send (unsigned short row,
unsigned short col,
const IccBuf& buffer)
- row
- The row where the writing of the data is started.
- col
- The column where the writing of the data is started.
- buffer
- A reference to an IccBuf object that holds the
data that is to be sent.
void send (unsigned short row,
unsigned short col,
const char* format,
...)
- row
- The row where the writing of the data is started.
- col
- The column where the writing of the data is started.
- format
- A format string, as in the printf standard library
function.
- ...
- The optional arguments that accompany format.
Writes the specified data to either the current cursor position or to the
cursor position specified by the arguments.
Conditions
void send3270Data(const IccBuf& buffer)
- buffer
- A reference to an IccBuf object that holds the
data that is to be sent.
void send3270 Data(const char* format,
...)
- format
- A format string, as in the printf standard library
function
- ...
- The optional arguments that accompany format.
void send3270Data (unsigned short col,
const IccBuf& buf)
- col
- The column where the writing of the data is started
- buffer
- A reference to an IccBuf object that holds the
data that is to be sent.
void send3270Data (unsigned short col,
const char* format,
...)
- col
- The column where the writing of the data is started
- format
- A format string, as in the printf standard library
function
- ...
- The optional arguments that accompany format.
Writes the specified data to either the next line of the terminal or to
the specified column of the current line.
Conditions
void sendLine(const IccBuf& buffer)
- buffer
- A reference to an IccBuf object that holds the
data that is to be sent.
void sendLine (const char* format,
...)
- format
- A format string, as in the printf standard library
function
- ...
- The optional arguments that accompany format.
void sendLine (unsigned short col,
const IccBuf& buf)
- col
- The column where the writing of the data is started
- buffer
- A reference to an IccBuf object that holds the
data that is to be sent.
void sendLine (unsigned short col,
const char* format,
...)
- col
- The column where the writing of the data is started
- format
- A format string, as in the printf standard library
function
- ...
- The optional arguments that accompany format.
Writes the specified data to either the next line of the terminal or to
the specified column of the current line.
Conditions
void setColor(Color color=defaultColor)
- color
- An enumeration, defined in this class, that indicates the color of the
text that is written to the screen.
Changes the color of the text subsequently sent to the terminal.
void setCursor(unsigned short offset)
- offset
- The position of the cursor where the top left corner is 0.
void setCursor (unsigned short row,
unsigned short col)
- row
- The row number of the cursor where the top row is 1
- col
- The column number of the cursor where the left column is 1
Two different ways of setting the position of the cursor on the screen.
Conditions
void setHighlight(Highlight highlight = normal)
- highlight
- An enumeration, defined in this class, that indicates the highlighting
of the text that is written to the screen.
Changes the higlighting of the data subsequently sent to the terminal.
void setLine(unsigned short lineNum = 1)
- lineNum
- The line number, counting from the top.
Moves the cursor to the start of line lineNum, where 1 is the
top line of the terminal. The default is to move the cursor to the start of
line 1.
Conditions
void setNewLine(unsigned short numLines = 1)
- numLines
- The number of blank lines.
Requests that numLines blank lines be sent to the terminal.
Conditions
void setNextCommArea(const IccBuf& commArea)
- commArea
- A reference to the buffer that is to be used as a COMMAREA.
Specifies the COMMAREA that is to be passed to the next transaction started
on this terminal.
void setNextInputMessage(const IccBuf& message)
- message
- A reference to the buffer that holds the input message.
Specifies data that is to be made available, by the receive method, to the next transaction started at this terminal.
void setNextTransId (const IccTransId& transid,
NextTransIdOpt opt = queue)
- transid
- A reference to the IccTransId object that holds
the name of a transaction
- opt
- An enumeration, defined in this class, that indicates whether transId should be queued or started immediately (that is, it should be the very
next transaction) at this terminal.
Specifies the next transaction that is to be started on this terminal.
Signs off the user who is currently signed on. Authority reverts to the
default user.
Conditions
void signon (const IccUserId& id,
const char* password = 0,
const char* newPassword = 0)
- id
- A reference to an IccUserId object
- password
- The 8-character existing password.
- newPassword
- An optional 8-character new password.
void signon (IccUser& user,
const char* password = 0,
const char* newPassword = 0)
- user
- A reference to an IccUser object
- password
- The 8-character existing password.
- newPassword
- An optional 8-character new password. This method differs from the first signon method in that the IccUser
object is interrogated to discover IccGroupId and language
information. The object is also updated with language and ESM return and response
codes.
Signs the user on to the terminal.
Conditions
INVREQ, NOTAUTH, USERIDERR
Waits for any input and returns an enumeration, defined in this class,
that indicates which AID key is expected.
void waitForAID(AIDVal aid)
- aid
- An enumeration, defined in this class, that indicates which AID key
was last pressed.
Waits for the specified AID key to be pressed, before returning control.
This method loops, receiving input from the terminal, until the correct AID
key is pressed by the operator.
Conditions
EOC, INVREQ, LENGERR, NOTALLOC, SIGNAL, TERMERR
unsigned short width(Icc::getopt opt = Icc::object)
Returns the width of the screen in characters.
Conditions
Returns a reference to the IccBuf object that holds
the terminal work area.
[[ Contents Previous Page | Next Page Index ]]