com.swath.cmd

Class PlotCourse

java.lang.Object

com.swath.Info

com.swath.cmd.PlotCourse

All Implemented Interfaces:

CommandIfc

public final class PlotCourse
extends Info

Plot the course between two sectors.
Prompts: Computer prompt

Since:

SWATH 1.4

Method Summary

Modifier and Type	Method and Description
static int[]	exec(int fromSector, int toSector) Plot the course between two sectors.
static Sector[]	exec(Sector fromSector, Sector toSector) Plot the course between two sectors.
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

Method Detail

initCommand

public boolean initCommand()
                    throws java.lang.Exception

Throws:

java.lang.Exception

exec

public static int[] exec(int fromSector,
                         int toSector)
                  throws java.lang.Exception

Plot the course between two sectors.

Parameters:

fromSector - The start sector.

toSector - The end sector.

Returns:

A sector array with the complete path or an empty array if there were none.

Throws:

java.lang.Exception

Since:

SWATH 1.4

exec

public static Sector[] exec(Sector fromSector,
                            Sector toSector)
                     throws java.lang.Exception

Plot the course between two sectors.

Parameters:

fromSector - The start sector.

toSector - The end sector.

Returns:

A sector array with the complete path or an empty array if there were none.

Throws:

java.lang.Exception

Since:

SWATH 1.6

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.