Package PamModel

Interface CommonPluginInterface

All Known Subinterfaces:
DaqSystemInterface, PamPluginInterface
All Known Implementing Classes:
angleMeasurementPlugin, ArrayAccelPlugin, ASIOInterface, AzigramPlugin, IMUPlugin, offlineProcessingPlugin, quickAnnotationPlugin, RawDeepLearningPlugin
public interface CommonPluginInterface
Interface for PAMGuard plugins.

Author:
MO

  • Method Details Link icon

    • getDefaultName Link icon

      String getDefaultName()
      The default name of the plugin.

      This field cannot be null.

      Returns:
      the default name of the plugin as a String. Cannot be null.

    • getHelpSetName Link icon

      String getHelpSetName()
      Return the name of the helpset file. For information on the helpset format, see
      invalid @link 
      {@link https://docs.oracle.com/cd/E19253-01/819-0913/author/helpset.html
      }.

      If the helpset file is in a package folder of the plugins folder, make sure to include that in the filename. For example, if the package name is MyFirstPlugin and the help file is MyPluginHelp.hs, the return should be:

      return "MyFirstPlugin/MyPluginHelp.hs";

      To create links into the main PAMGuard help, you need a special pattern at the start of each hyperlink, for example
      href="_mainHelp_detectors/clickDetectorHelp/docs/ClickDetector_clickDetector.html or
      href="_mainHelp_overview/PamMasterHelp/docs/normalMode.html"

      To make a link to context sensitive help in a dialog, or any other button that uses a call to PamHelp.getInstance().displayContextSensitiveHelp(...) the helpset name (or helpPoint) should be relative to the path of this helpset, e.g. if getHelpSetName returns "pambatch/help/BatchHelp.hs" and the html files are in a subfolder of help called docs, then a typical helpPoint might be hp = "docs.batchoverview"

      If there is no helpset file, return null.

      Returns:

    • setJarFile Link icon

      void setJarFile(String jarFile)
      Sets the name of the jar file (including path) holding the plugin code. This method is called from PamModel.loadPlugins(PamModuleInfo) for every valid interface file found in the plugins folder.
      Parameters:
      jarFile - String containing the jarFile name and absolute path

    • getJarFile Link icon

      String getJarFile()
      Returns the name of the jar file holding the plugin. The jarFile String should be declared as a class field, but does not need to be initialised to anything specific as it will be set by Pamguard in the PamModel.loadPlugins(PamModuleInfo) method when the plugin was first found.
      Returns:

    • getDeveloperName Link icon

      String getDeveloperName()
      Returns the name of the developer. Can be company name or individual.
      Returns:
      String containing the name of the developer. Cannot be null.

    • getContactEmail Link icon

      String getContactEmail()
      Returns the developer's contact email
      Returns:
      String containing the developer's contact email. Cannot be null.

    • getVersion Link icon

      String getVersion()
      Returns the version number of the plugin
      Returns:
      String containing the plugin version number. Cannot be null

    • getPamVerDevelopedOn Link icon

      String getPamVerDevelopedOn()
      The Pamguard version number that the plugin was developed on.
      Returns:
      String containing the version number of Pamguard that the plugin was developed on. Cannot be null.

    • getPamVerTestedOn Link icon

      String getPamVerTestedOn()
      The Pamguard version number that the plugin has been tested on.
      Returns:
      String containing the latest version of Pamguard that the plugin has been tested on. Cannot be null.

    • getAboutText Link icon

      String getAboutText()
      A brief description of the plugin. This will be displayed in the Help>About window. Could include not just a description of the plugin, but also the developer's website and additional contact information.
      Returns:
      String containing a description of the plugin. Cannot be null