org.gjt.universe
Class OrderMove

java.lang.Object
  |
  +--org.gjt.universe.Order
        |
        +--org.gjt.universe.OrderMove

All Implemented Interfaces:

java.io.Serializable

public class OrderMove

extends Order

See Also:

Serialized Form

Field Summary

private Location	destination
private float	distance
private FleetID	FID
private Location	origin

Constructor Summary

OrderMove(FleetID FID)
This method is used to create a potential order for the given fleet, where the destination and orgin have yet to be specified.

OrderMove(FleetID FID, Location destination, Location origin)

Method Summary

void	atPosition(int i) This method handles anything that needs to be done when the order is at a specific position int a queue.
void	delete()
Location	getDestination()
float	getDistance()
int	getEstimatedTimeOfCompletion()
FleetID	getFleet()
Index	getKey()
float	getPercentageCompletion()
boolean	process() This method processes the appropriate order.
void	setDestination(Location newValue)
VectorDisplayReturn	specificDisplayDebug()
void	submit()
java.lang.String	toString()

Methods inherited from class org.gjt.universe.Order

getName

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

FID

private FleetID FID

destination

private Location destination

origin

private Location origin

distance

private float distance

Constructor Detail

OrderMove

public OrderMove(FleetID FID,
                 Location destination,
                 Location origin)

OrderMove

public OrderMove(FleetID FID)

This method is used to create a potential order for the given fleet, where the destination and orgin have yet to be specified. When this order is activated, the fleet's current location will be used as the origin, and, if no destination has been specified the civ asked to select one.

Method Detail

getFleet

public FleetID getFleet()

getDestination

public Location getDestination()

setDestination

public void setDestination(Location newValue)

process

public boolean process()

Description copied from class: Order

This method processes the appropriate order. If this method returns a true, then the order is complete and can be removed.

Specified by:

process in class Order

getKey

public Index getKey()

Specified by:

getKey in class Order

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getEstimatedTimeOfCompletion

public int getEstimatedTimeOfCompletion()

Specified by:

getEstimatedTimeOfCompletion in class Order

getDistance

public float getDistance()

getPercentageCompletion

public float getPercentageCompletion()

Specified by:

getPercentageCompletion in class Order

specificDisplayDebug

public VectorDisplayReturn specificDisplayDebug()

atPosition

public void atPosition(int i)

Description copied from class: Order

This method handles anything that needs to be done when the order is at a specific position int a queue. Notes:

• The method *must* be able to be called multiple times at the same position, because it almost certainly will be. It *must* handle this situation correctly.
• The method *must not* count on having each position called int order. Nor must it count on the position numbers being sequential -- if an order is inserted, it may be called with a higher number than the previous time. Or, if an order is deleted, it may be called with a number 2 or more below the last one it was called with. It is up to the method to handle this appropriately.

  Specified by:

  atPosition in class Order

submit

public void submit()

Specified by:

submit in class Order

delete

public void delete()

Specified by:

delete in class Order