org.gjt.universe
Class OrderTransitWormhole

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

All Implemented Interfaces:

java.io.Serializable

public class OrderTransitWormhole

extends Order

See Also:

Serialized Form

Field Summary

private SystemBase	destination
private FleetID	FID
private SystemBase	origin
private Wormhole	wormhole

Constructor Summary

OrderTransitWormhole(FleetID FID, Wormhole wormhole, SystemBase origin, SystemBase destination)
This is the designated constructor for instances of this class.

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()
SystemBase	getDestination() Returns the star system containing the wormhole end-point which the fleet will exit.
int	getEstimatedTimeOfCompletion()
FleetID	getFleet() Returns the unique ID of the fleet which is being ordered through the wormhole.
Index	getKey()
SystemBase	getOrigin() Returns the star system containing the wormhole end-point which the fleet will enter.
float	getPercentageCompletion()
Wormhole	getWormhole() Returns the wormhole that the fleet is to travel through.
boolean	process() This method processes the appropriate order.
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 SystemBase destination

origin

private SystemBase origin

wormhole

private Wormhole wormhole

Constructor Detail

OrderTransitWormhole

public OrderTransitWormhole(FleetID FID,
                            Wormhole wormhole,
                            SystemBase origin,
                            SystemBase destination)

This is the designated constructor for instances of this class. Note that both the origin and destination must be specified in order to deal correctly with oscillating wormholes.

Parameters:

FID - The unique ID of the fleet to be moved through the wormhole.

wormhole - The wormhole that the fleet is to move through.

origin - The system containing the wormhole end-point which the fleet will enter.

destination - The system containing the wormhole end-point which the fleet will exit.

Method Detail

getFleet

public FleetID getFleet()

Returns the unique ID of the fleet which is being ordered through the wormhole.

getWormhole

public Wormhole getWormhole()

Returns the wormhole that the fleet is to travel through.

getOrigin

public SystemBase getOrigin()

Returns the star system containing the wormhole end-point which the fleet will enter.

getDestination

public SystemBase getDestination()

Returns the star system containing the wormhole end-point which the fleet will exit.

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

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