Package bearinglocaliser

Class BearingLocaliserControl

java.lang.Object
PamController.PamControlledUnit
bearinglocaliser.BearingLocaliserControl
All Implemented Interfaces:
LocalisationAlgorithm, LocalisationAlgorithmInfo, PamSettings, SettingsNameProvider
public class BearingLocaliserControl extends PamControlledUnit implements PamSettings, LocalisationAlgorithm, LocalisationAlgorithmInfo

  • Field Details

  • Constructor Details

    • BearingLocaliserControl

      public BearingLocaliserControl(String unitName)

  • Method Details

    • removeUnit

      public boolean removeUnit()
      Description copied from class: PamControlledUnit
      Called to remove a unit.
      Overrides:
      removeUnit in class PamControlledUnit
      Returns:
      try (not used)

    • 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.

    • 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

    • showDetectionMenu

      public void showDetectionMenu(Frame parentFrame)

    • getAlgorithmList

      public List<BearingAlgorithmProvider> getAlgorithmList()

    • findAlgorithmByName

      public BearingAlgorithmProvider findAlgorithmByName(String algoName)
      Find an algorithm provider by name.
      Parameters:
      algoName - algorithm name
      Returns:

    • 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
      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

    • getBearingLocaliserParams

      public BearingLocaliserParams getBearingLocaliserParams()
      Returns:
      the bearingLocaliserParams

    • estimateBearings

      public void estimateBearings(PamDataUnit triggerData)

    • getBearingProcess

      public BearingProcess getBearingProcess()
      Returns:
      the bearingProcess

    • getDetectionMonitor

      public DetectionMonitor getDetectionMonitor()
      Returns:
      the detectionMonitor

    • getBearingAnnotationType

      public BearingAnnotationType getBearingAnnotationType()
      Returns:
      the bearingAnnotationType

    • getConfigObservable

      public SimpleObservable<PamDataUnit> getConfigObservable()
      Returns:
      the configObservable

    • addDownstreamLocalisationContents

      public void addDownstreamLocalisationContents(int localisationContents)

    • getHelpPoint

      public String getHelpPoint()

    • 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.

    • getLocalisationContents

      public int getLocalisationContents()
      Description copied from interface: LocalisationAlgorithmInfo
      Get the likely content flags for this localiser.
      Specified by:
      getLocalisationContents in interface LocalisationAlgorithmInfo
      Returns:
      localisation flags.
      See Also:

    • getAlgorithmName

      public String getAlgorithmName()
      Description copied from interface: LocalisationAlgorithmInfo
      Get the algorithm name
      Specified by:
      getAlgorithmName in interface LocalisationAlgorithmInfo
      Returns:
      algorithm name

    • getParameters

      public Serializable getParameters()
      Description copied from interface: LocalisationAlgorithmInfo
      Get the algorithm parameters. Something else can turn these into xml for Tethys.
      Specified by:
      getParameters in interface LocalisationAlgorithmInfo
      Returns:
      algorithm parameters object. Might be null;