com.wrq.vhi.script.api.command
Class WriteVariableToLocation

java.lang.Object
  com.wrq.vhi.script.api.command.Command
      com.wrq.vhi.script.api.command.WriteVariableToLocation

public class WriteVariableToLocation
extends Command

A class that represents a VHI WriteVariableToLocation command.

See Also:

CommandList, HostSession.executeCommandList(com.wrq.vhi.script.api.command.CommandList), HostSession.writeVariableToLocation(java.lang.String, int, int, int, boolean, int)

Constructor Summary

WriteVariableToLocation(java.lang.String variable, int row, int column, int maxLength, boolean erase, int waitForEcho)
Constructs a new WriteVarToLocation command.

Method Summary

int	getColumn() Gets the column.
int	getMaxLength() Gets the max length.
java.lang.String	getName() Gets the command name.
int	getRow() Gets the row.
java.lang.String	getVariable() Gets the variable name.
int	getWaitForEcho() Gets the wait for echo mode.
boolean	isErase() Gets the erase flag.

Methods inherited from class com.wrq.vhi.script.api.command.Command

isValidEchoType

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WriteVariableToLocation

public WriteVariableToLocation(java.lang.String variable,
                               int row,
                               int column,
                               int maxLength,
                               boolean erase,
                               int waitForEcho)

Constructs a new WriteVarToLocation command.

Parameters:

variable - name variable containing value to be written

row - the row of the location to be written to

column - the starting column of the location to be written to

maxLength - the maximum number of characters to write

erase - if true and if the length of the string contained in variable is less than maxLength, pad the value written with spaces until maxLength characters have been written.

waitForEcho - type of wait for echo to perform. See HostSession.writeVariableToLocation(java.lang.String, int, int, int, boolean, int) for values.

Method Detail

getVariable

public java.lang.String getVariable()

Gets the variable name.

Returns:

name of variable to be read

getRow

public int getRow()

Gets the row.

Returns:

the row of the location to be written to

getColumn

public int getColumn()

Gets the column.

Returns:

the starting column of the location to be written to

getMaxLength

public int getMaxLength()

Gets the max length.

Returns:

the maximum number of characters to write

isErase

public boolean isErase()

Gets the erase flag.

Returns:

if true and if the maxLength of the string contained in variable is less than maxLength, pad the value written with spaces until maxLength characters have been written.

getWaitForEcho

public int getWaitForEcho()

Gets the wait for echo mode.

Returns:

type of wait for echo to perform. See HostSession.transmit(java.lang.String).

getName

public java.lang.String getName()

Gets the command name.

Specified by:

getName in class Command

Returns:

the command name