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

java.lang.Object
  extended by com.wrq.vhi.script.api.command.Command
      extended by com.wrq.vhi.script.api.command.ReadVariableFromTerminal

public class ReadVariableFromTerminal
extends Command

A class that represents a VHI ReadVariableFromTerminal command.

See Also:
CommandList, HostSession.executeCommandList(com.wrq.vhi.script.api.command.CommandList), HostSession.readVariableFromTerminal(java.lang.String, int)

Constructor Summary
ReadVariableFromTerminal(java.lang.String variable, int length)
          Constructs a new ReadVarFromTerminal command.
 
Method Summary
 int getLength()
          Gets the variable length.
 java.lang.String getName()
          Gets the command name.
 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

ReadVariableFromTerminal

public ReadVariableFromTerminal(java.lang.String variable,
                                int length)
Constructs a new ReadVarFromTerminal command.

Parameters:
variable - the variable name
length - the number of characters to read
Method Detail

getVariable

public java.lang.String getVariable()
Gets the variable name.

Returns:
the variable name

getLength

public int getLength()
Gets the variable length.

Returns:
the variable length

getName

public java.lang.String getName()
Gets the command name.

Specified by:
getName in class Command
Returns:
the command name