Package simulatedAcquisition.movement

Class CircularMovement

java.lang.Object
simulatedAcquisition.movement.MovementModel
simulatedAcquisition.movement.CircularMovement
All Implemented Interfaces:
PamSettings, SettingsNameProvider
public class CircularMovement extends MovementModel implements PamSettings

  • Constructor Details

    • CircularMovement

      public CircularMovement(SimObject simObject)

  • Method Details

    • start

      public boolean start(long timeMilliseconds, SimObjectDataUnit simObjectDataUnit)
      Description copied from class: MovementModel
      Prepare to start moving. Called once at run start.
      Specified by:
      start in class MovementModel
      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 boolean takeStep(long timeMilliseconds, SimObjectDataUnit simObjectDataUnit)
      Description copied from class: MovementModel
      Take a step. Update the position, heading, etc. directly in the SimSoundDataUnit.
      Specified by:
      takeStep in class MovementModel
      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 String getName()
      Specified by:
      getName in class MovementModel
      Returns:
      Name for the model.

    • getUnitName

      public String getUnitName()
      Specified by:
      getUnitName in interface SettingsNameProvider
      Returns:
      A Name specific to this instance of the particular class, e.g. Sperm whale detector, Beaked whale detector, etc.

    • getUnitType

      public String getUnitType()
      Specified by:
      getUnitType in interface PamSettings
      Returns:
      A Name specific to the type, e.g. Click detector

    • getSettingsReference

      public Serializable getSettingsReference()
      Specified by:
      getSettingsReference in interface PamSettings
      Returns:
      The serialisable object that will be stored

    • getSettingsVersion

      public long getSettingsVersion()
      Specified by:
      getSettingsVersion in interface PamSettings
      Returns:
      An integer version number for the settings

    • restoreSettings

      public boolean restoreSettings(PamControlledUnitSettings pamControlledUnitSettings)
      Specified by:
      restoreSettings in interface PamSettings
      Parameters:
      pamControlledUnitSettings -
      Returns:
      true if successful The object performs final checks (if needed) and then casts the settings data pamcontrolledunitSettings.settings into the correct type and uses as required

    • hasOptions

      public boolean hasOptions()
      Description copied from class: MovementModel
      Has configurable options.
      Overrides:
      hasOptions in class MovementModel
      Returns:
      true of it has a dialog

    • showOptions

      public boolean showOptions(Window window, SimObject simObject)
      Description copied from class: MovementModel
      Show options dialog. All options to be handled and stored internally by the MovementModel.
      Overrides:
      showOptions in class MovementModel
      Parameters:
      window -
      simObject -
      Returns: