com.swath.cmd

Class SetNavPoint

java.lang.Object

com.swath.Info

com.swath.cmd.SetNavPoint

All Implemented Interfaces:

CommandIfc

public final class SetNavPoint
extends Info

Set a user NavPoint.
Prompts: Command prompt

Since:

SWATH 1.7

See Also:

MoveToNavPoint, GetNavPoints

Field Summary

Fields

Modifier and Type	Field and Description
static int	NAV_POINT_1 The first user NavPoint.
static int	NAV_POINT_2 The second user NavPoint.
static int	NAV_POINT_3 The third user NavPoint.
static int	NAV_POINT_4 The fourth user NavPoint.

Method Summary

Modifier and Type	Method and Description
static void	exec(int navPoint, int sector) Set a user NavPoint.
static void	exec(int navPoint, Sector sector) Set a user NavPoint.
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

NAV_POINT_1

public static final int NAV_POINT_1

The first user NavPoint.

See Also:

Constant Field Values

NAV_POINT_2

public static final int NAV_POINT_2

The second user NavPoint.

See Also:

Constant Field Values

NAV_POINT_3

public static final int NAV_POINT_3

The third user NavPoint.

See Also:

Constant Field Values

NAV_POINT_4

public static final int NAV_POINT_4

The fourth user NavPoint.

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 navPoint,
                        int sector)
                 throws java.lang.Exception

Set a user NavPoint.

Parameters:

navPoint - The user NavPoint to set.

sector - The sector or 0 to clear the NavPoint.

Throws:

java.lang.Exception

Since:

SWATH 1.7

See Also:

NAV_POINT_1, NAV_POINT_2, NAV_POINT_3, NAV_POINT_4

exec

public static void exec(int navPoint,
                        Sector sector)
                 throws java.lang.Exception

Set a user NavPoint.

Parameters:

navPoint - The user NavPoint to set.

sector - The sector or null to clear the NavPoint.

Throws:

java.lang.Exception

Since:

SWATH 1.7

See Also:

NAV_POINT_1, NAV_POINT_2, NAV_POINT_3, NAV_POINT_4

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.