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

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

public class Transmit
extends Command

A class that represents a VHI Transmit command.

Constructor Summary

Transmit(java.lang.String text)
Constructs a new Transmit command using HostSession.DONT_WAIT_FOR_ECHO.

Transmit(java.lang.String text, int waitForEcho)
Constructs a new Transmit command.

Method Summary

java.lang.String	getName() Gets the command name.
java.lang.String	getText() Gets the text to transmit.
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

Transmit

public Transmit(java.lang.String text)

Constructs a new Transmit command using HostSession.DONT_WAIT_FOR_ECHO.

Parameters:

text - the text to transmit

Transmit

public Transmit(java.lang.String text,
                int waitForEcho)

Constructs a new Transmit command.

Parameters:

text - the text to transmit

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

Method Detail

getText

public java.lang.String getText()

Gets the text to transmit.

Returns:

the text to transmit

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