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

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

public class ReadVariableFromLocation
extends Command

A class that represents a VHI ReadVariableFromLocation command.

See Also:

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

Constructor Summary

ReadVariableFromLocation(java.lang.String variable, int row, int column, int length)
Constructs a new ReadVarFromLocation command.

Method Summary

int	getColumn() Gets the column.
int	getLength() Gets the length.
java.lang.String	getName() Gets the command name.
int	getRow() Gets the row.
java.lang.String	getVariable() Gets the variable name.

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

ReadVariableFromLocation

public ReadVariableFromLocation(java.lang.String variable,
                                int row,
                                int column,
                                int length)

Constructs a new ReadVarFromLocation command.

Parameters:

variable - the variable name

row - the one-based row

column - the one-based column

length - the number of characters to read

Method Detail

getVariable

public java.lang.String getVariable()

Gets the variable name.

Returns:

the variable name

getRow

public int getRow()

Gets the row.

Returns:

the one-based row

getColumn

public int getColumn()

Gets the column.

Returns:

the one-based column

getLength

public int getLength()

Gets the length.

Returns:

the length

getName

public java.lang.String getName()

Gets the command name.

Specified by:

getName in class Command

Returns:

the command name