Package group3dlocaliser

Class Group3DLocaliserControl

java.lang.Object
PamController.PamControlledUnit
group3dlocaliser.Group3DLocaliserControl
All Implemented Interfaces:
LocalisationAlgorithm, PamSettings, SettingsNameProvider
public class Group3DLocaliserControl extends PamControlledUnit implements PamSettings, LocalisationAlgorithm

  • Field Details

  • Constructor Details

    • Group3DLocaliserControl

      public Group3DLocaliserControl(String unitName)

  • Method Details

    • 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

    • createDetectionMenu

      public JMenuItem createDetectionMenu(Frame parentFrame)
      Description copied from class: PamControlledUnit
      Create a JMenu object containing MenuItems associated with PamProcesses
      Overrides:
      createDetectionMenu in class PamControlledUnit
      Parameters:
      parentFrame - The owner frame of the menu
      Returns:
      reference to a JMenu which can be added to an existing menu or menu bar

      Note that if multiple views are to use the same menu, then they should each create a new menu (by setting Create to true) the first time they call this method.

    • runOfflineProcessing

      protected void runOfflineProcessing()

    • showSettingsMenu

      public boolean showSettingsMenu(Frame parentFrame)

    • getGrid3dParams

      public Group3DParams getGrid3dParams()
      Returns:
      the grid3dParams

    • setGrid3dParams

      public void setGrid3dParams(Group3DParams grid3dParams)
      Parameters:
      grid3dParams - the grid3dParams to set

    • getLocaliserAlgorithmParams

      public LocaliserAlgorithmParams getLocaliserAlgorithmParams(LocaliserAlgorithm3D algoProvider)
      Get the parameters for a specific algorithm type
      Parameters:
      algoProvider - algorithm provider
      Returns:
      algorithm params or null if not yet set

    • setAlgorithmParams

      public void setAlgorithmParams(LocaliserAlgorithm3D algoProvider, LocaliserAlgorithmParams localiserAlgorithmParams)
      Set the parameters for a specific algorithm type
      Parameters:
      algoProvider - algorithm provider
      localiserAlgorithmParams - specific params, or null to remove them from the list.

    • notifyModelChanged

      public void notifyModelChanged(int changeType)
      Description copied from class: PamControlledUnit
      General notification when the PAMGAURD model changes.
      Overrides:
      notifyModelChanged in class PamControlledUnit
      Parameters:
      changeType - type of change

    • findAlgorithm

      public LocaliserAlgorithm3D findAlgorithm(String algorithmName)
      Find an algorithm provider with the given name.
      Parameters:
      algorithmName - Algorithm name
      Returns:
      Algorithm Provider

    • getAlgorithmProviders

      public ArrayList<LocaliserAlgorithm3D> getAlgorithmProviders()
      Returns:
      the algorithmProviders

    • getDataSelectorName

      public String getDataSelectorName()

    • getGroup3dProcess

      public Group3DProcess getGroup3dProcess()
      Returns:
      the group3dProcess

    • getG3DOfflineTask

      public Group3DOfflineTask getG3DOfflineTask()
      Returns:
      the g3DOfflineTask

    • getAlgorithmInfo

      public LocalisationAlgorithmInfo getAlgorithmInfo()
      Description copied from interface: LocalisationAlgorithm
      Get information about the localisation algorithm.
      Specified by:
      getAlgorithmInfo in interface LocalisationAlgorithm
      Returns:
      algorithm information.

    • getTethysCreator

      public LocalizationCreator getTethysCreator()
      Description copied from interface: LocalisationAlgorithm
      Get something that can make LocalisationType objects of a form a bit bespoke to the type of localiser. This may be better than having the standard functions in LocalizationBuilder guess what's best.
      Specified by:
      getTethysCreator in interface LocalisationAlgorithm
      Returns:
      can be null in which case standard functions will do the best they can.

    • getGroup3dParams

      public Group3DParams getGroup3dParams()
      Returns:
      the group3dParams