Public methods

The opt parameter

Many methods have the same parameter, opt, which is described under the abendCode method inabendCode.

AID

AIDVal AID()

Returns an enumeration, defined in this class, that indicates which AID (action identifier) key was last pressed at this terminal.

clear

virtual void clear()

A synonym for erase. See Polymorphic Behavior for information on polymorphism.

cursor

unsigned short cursor()

Returns the current cursor position as an offset from the top left corner of the screen.

data

IccTerminalData* data()

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

void erase()

Erase all the data displayed at the terminal.

Conditions

INVREQ, INVPARTN

freeKeyboard

void freeKeyboard()

Frees the keyboard so that the terminal can accept input.

Conditions

INVREQ, INVPARTN

get

virtual const IccBuf& get()

A synonym for receive. See Polymorphic Behavior for information on polymorphism.

height

unsigned short height(Icc::getopt opt = Icc::object)

Returns how many lines the screen holds.

Conditions

INVREQ

inputCursor

unsigned short inputCursor()

Returns the position of the cursor on the screen.

instance

static IccTerminal* instance()

Returns a pointer to the single IccTerminal object. The object is created if it does not already exist.

line

unsigned short line()

Returns the current line number of the cursor from the top of the screen.

netName

const char* netName()

Returns the 8-byte string representing the network logical unit name of the principal facility.

operator<< (1)

IccTerminal& operator << (Color color)

Sets the foreground color for data subsequently sent to the terminal.

operator<< (2)

IccTerminal& operator << (Highlight highlight)

Sets the highlighting used for data subsequently sent to the terminal.

operator<< (3)

IccTerminal& operator << (const IccBuf& buffer)

Writes another buffer.

operator<< (4)

IccTerminal& operator << (char ch)

Writes a character.

operator<< (5)

IccTerminal& operator << (signed char ch)

Writes a character.

operator<< (6)

IccTerminal& operator << (unsigned char ch)

Writes a character.

operator<< (7)

IccTerminal& operator << (const char* text)

Writes a string.

operator<< (8)

IccTerminal& operator << (const signed char* text)

Writes a string.

operator<< (9)

IccTerminal& operator << (const unsigned char* text)

Writes a string.

operator<< (10)

IccTerminal& operator << (short num)

Writes a short.

operator<< (11)

IccTerminal& operator << (unsigned short num)

Writes an unsigned short.

operator<< (12)

IccTerminal& operator << (long num)

Writes a long.

operator<< (13)

IccTerminal& operator << (unsigned long num)

Writes an unsigned long.

operator<< (14)

IccTerminal& operator << (int num)

Writes an integer.

operator<< (15)

IccTerminal& operator << (float num)

Writes a float.

operator<< (16)

IccTerminal& operator << (double num)

Writes a double.

operator<< (17)

IccTerminal& operator << (long double num)

Writes a long double.

operator<< (18)

IccTerminal& operator << (IccTerminal& (*f)(IccTerminal&))

Enables the following syntax:

Term << "Hello World" << endl;
Term << "Hello again" << flush;

put

virtual void put(const IccBuf& buf)

A synonym for sendLine. See Polymorphic Behavior for information on polymorphism.

receive

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

receive3270Data

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

INVREQ, LENGERR, TERMERR

send (1)

void send(const IccBuf& buffer)
buffer
A reference to an IccBuf object that holds the data that is to be sent.

send (2)

void send (const char* format,
           ...)

format
A format string, as in the printf standard library function.
...
The optional arguments that accompany format.

send (3)

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.

send (4)

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

INVREQ, LENGERR, TERMERR

send3270Data (1)

void send3270Data(const IccBuf& buffer)
buffer
A reference to an IccBuf object that holds the data that is to be sent.

send3270Data (2)

void send3270 Data(const char* format,
               ...)

format
A format string, as in the printf standard library function
...
The optional arguments that accompany format.

send3270Data (3)

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.

send3270Data (4)

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

INVREQ, LENGERR, TERMERR

sendLine (1)

void sendLine(const IccBuf& buffer)
buffer
A reference to an IccBuf object that holds the data that is to be sent.

sendLine (2)

void sendLine (const char* format,
               ...)

format
A format string, as in the printf standard library function
...
The optional arguments that accompany format.

sendLine (3)

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.

sendLine (4)

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

INVREQ, LENGERR, TERMERR

setColor

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.

setCursor (1)

void setCursor(unsigned short offset)
offset
The position of the cursor where the top left corner is 0.

setCursor (2)

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

INVREQ, INVPARTN

setHighlight

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.

setLine

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

INVREQ, INVPARTN

setNewLine

void setNewLine(unsigned short numLines = 1)
numLines
The number of blank lines.

Requests that numLines blank lines be sent to the terminal.

Conditions

INVREQ, INVPARTN

setNextCommArea

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.

setNextInputMessage

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.

setNextTransId

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.

signoff

void signoff()

Signs off the user who is currently signed on. Authority reverts to the default user.

Conditions

INVREQ

signon (1)

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.

signon (2)

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

waitForAID (1)

AIDVal waitForAID()

Waits for any input and returns an enumeration, defined in this class, that indicates which AID key is expected.

waitForAID (2)

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

width

unsigned short width(Icc::getopt opt = Icc::object)

Returns the width of the screen in characters.

Conditions

INVREQ

workArea

IccBuf& workArea()

Returns a reference to the IccBuf object that holds the terminal work area.

[[ Contents Previous Page | Next Page Index ]]