com.swath.cmd
Class ScanSector

java.lang.Object
  extended bycom.swath.Info
      extended bycom.swath.cmd.SwathCommand
          extended bycom.swath.cmd.ScanSector
All Implemented Interfaces:
CommandIfc

public final class ScanSector
extends com.swath.cmd.SwathCommand

Perform a long range scan in the current sector.
Prompts: Command prompt

Since:
SWATH 1.3

Field Summary
static int DENSITY_SCAN
          Density scan.
static int HOLO_SCAN
          Holographic scan.
 
Method Summary
static void exec(int scanType)
          Perform a long range scan in the current sector.
 java.lang.String getClassName()
          Gets the command class name.
 java.lang.String getName()
          Gets the name of the command.
 java.util.Enumeration getParams()
          Gets the command parameters.
 boolean initCommand()
           
 boolean isInternal()
          Indicates if this is an internal SWATH command or not.
 boolean isUserDefined()
          Indicates if this command is user defined or not.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

DENSITY_SCAN

public static final int DENSITY_SCAN
Density scan.

See Also:
Constant Field Values

HOLO_SCAN

public static final int HOLO_SCAN
Holographic scan.

See Also:
Constant Field Values
Method Detail

initCommand

public boolean initCommand()
                    throws java.lang.Exception
Throws:
java.lang.Exception

exec

public static void exec(int scanType)
                 throws java.lang.Exception
Perform a long range scan in the current sector.

Parameters:
scanType - The type of scan to make.
Throws:
java.lang.Exception
Since:
SWATH 1.3
See Also:
DENSITY_SCAN, HOLO_SCAN

isUserDefined

public final boolean isUserDefined()
Description copied from interface: CommandIfc
Indicates if this command is user defined or not.

Specified by:
isUserDefined in interface CommandIfc
Returns:
true if user defined, otherwise false.

getName

public final java.lang.String getName()
Description copied from interface: CommandIfc
Gets the name of the command.

Specified by:
getName in interface CommandIfc
Returns:
The command name.

getClassName

public final java.lang.String getClassName()
Description copied from interface: CommandIfc
Gets the command class name.

Specified by:
getClassName in interface CommandIfc
Returns:
The class name.

getParams

public final java.util.Enumeration getParams()
Description copied from interface: CommandIfc
Gets the command parameters.

Specified by:
getParams in interface CommandIfc
Returns:
The command parameters.

isInternal

public boolean isInternal()
Description copied from interface: CommandIfc
Indicates if this is an internal SWATH command or not.

Specified by:
isInternal in interface CommandIfc
Returns:
true if internal, otherwise false.