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

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

public class TransmitToLocation
extends Command

A class that represents a VHI TransmitToLocation command.

See Also:

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

Constructor Summary

TransmitToLocation(java.lang.String value, int row, int column, int waitForEcho)
Constructs a new TransmitToLocation command.

Method Summary

int	getColumn() Gets the column.
java.lang.String	getName() Gets the command name.
int	getRow() Gets the row.
java.lang.String	getValue() Gets the value.
int	getWaitForEcho() Gets the wait for echo mode.

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

TransmitToLocation

public TransmitToLocation(java.lang.String value,
                          int row,
                          int column,
                          int waitForEcho)

Constructs a new TransmitToLocation command.

Parameters:

value - the value to transmit

row - the one-based row

column - the one-based column

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

Method Detail

getValue

public java.lang.String getValue()

Gets the value.

Returns:

the value

getRow

public int getRow()

Gets the row.

Returns:

the one-based row

getColumn

public int getColumn()

Gets the column.

Returns:

the one-based column

getWaitForEcho

public int getWaitForEcho()

Gets the wait for echo mode.

Returns:

type of wait for echo to perform. See HostSession.transmitToLocation(java.lang.String, int, int).

getName

public java.lang.String getName()

Gets the command name.

Specified by:

getName in class Command

Returns:

the command name