simulatedAcquisition.movement

Class MovementModel

java.lang.Object

simulatedAcquisition.movement.MovementModel

Direct Known Subclasses:

GridMovement, StraightLineMovement

public abstract class MovementModel
extends java.lang.Object

Model of movement of a simulated object.

Author:

doug

Constructor Summary

Constructors

Constructor and Description
MovementModel(SimObject simObject)

Method Summary

Methods

Modifier and Type	Method and Description
abstract java.lang.String	getName()
SimObject	getSimObject()
boolean	hasOptions() Has configurable options.
boolean	showOptions(java.awt.Window window, SimObject simObject) Show options dialog.
abstract boolean	start(long timeMilliseconds, SimObjectDataUnit simObjectDataUnit) Prepare to start moving.
abstract boolean	takeStep(long timeMilliseconds, SimObjectDataUnit simObjectDataUnit) Take a step.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MovementModel

public MovementModel(SimObject simObject)

Method Detail

start

public abstract boolean start(long timeMilliseconds,
            SimObjectDataUnit simObjectDataUnit)

Prepare to start moving. Called once at run start.

Parameters:

timeMilliseconds - current time in milliseconds

simObjectDataUnit - Some data unit to modify.

Returns:

true if step taken OK. False if track is completed, in which case acquisition will stop.

takeStep

public abstract boolean takeStep(long timeMilliseconds,
               SimObjectDataUnit simObjectDataUnit)

Take a step. Update the position, heading, etc. directly in the SimSoundDataUnit.

Parameters:

timeMilliseconds - current time in milliseconds

simObjectDataUnit - Some data unit to modify.

Returns:

true if step taken OK. False if track is completed, in which case acquisition will stop.

getName

public abstract java.lang.String getName()

Returns:

Name for the model.

hasOptions

public boolean hasOptions()

Has configurable options.

Returns:

true of it has a dialog

showOptions

public boolean showOptions(java.awt.Window window,
                  SimObject simObject)

Show options dialog. All options to be handled and stored internally by the MovementModel.

Parameters:

window -

simObject -

Returns:

getSimObject

public SimObject getSimObject()

Returns:

the simObject