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

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

public class TransmitToOffset
extends Command

A class that represents a VHI TransmitToOffset command.

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

Constructor Summary
TransmitToOffset(java.lang.String value, int offset, int waitForEcho)
          Constructs a new TransmitToOffset command.
 
Method Summary
 java.lang.String getName()
          Gets the command name.
 int getOffset()
          Gets the offset.
 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

TransmitToOffset

public TransmitToOffset(java.lang.String value,
                        int offset,
                        int waitForEcho)
Constructs a new TransmitToOffset command.

Parameters:
value - the value to transmit
offset - the zero-based offset
waitForEcho - type of wait for echo to perform. See HostSession.transmitToOffset(java.lang.String, int).
Method Detail

getValue

public java.lang.String getValue()
Gets the value.

Returns:
the value

getOffset

public int getOffset()
Gets the offset.

Returns:
the zero-based offset

getWaitForEcho

public int getWaitForEcho()
Gets the wait for echo mode.

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

getName

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

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