Package asiojni

Class ASIOInterface

java.lang.Object
asiojni.ASIOInterface
All Implemented Interfaces:
DaqSystemInterface, CommonPluginInterface
public class ASIOInterface extends Object implements DaqSystemInterface

  • Constructor Details

    • ASIOInterface

      public ASIOInterface()

  • Method Details

    • createDAQControl

      public DaqSystem createDAQControl(AcquisitionControl acquisitionControl)
      Description copied from interface: DaqSystemInterface
      Creates a new instance of the DAQ System controller, the class that extends DaqSystem.class. The AcquisitionControl object that gets passed to the interface provides the DAQ System with a link to hardware information e.g. channel list, sample rate, etc.

      This field cannot be null.

      Specified by:
      createDAQControl in interface DaqSystemInterface
      Returns:
      the DaqSystem object

    • getHelpSetName

      public String getHelpSetName()
      Description copied from interface: CommonPluginInterface
      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.

      Specified by:
      getHelpSetName in interface CommonPluginInterface
      Returns:

    • setJarFile

      public void setJarFile(String jarFile)
      Description copied from interface: CommonPluginInterface
      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.
      Specified by:
      setJarFile in interface CommonPluginInterface
      Parameters:
      jarFile - String containing the jarFile name and absolute path

    • getJarFile

      public String getJarFile()
      Description copied from interface: CommonPluginInterface
      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.
      Specified by:
      getJarFile in interface CommonPluginInterface
      Returns:

    • getDeveloperName

      public String getDeveloperName()
      Description copied from interface: CommonPluginInterface
      Returns the name of the developer. Can be company name or individual.
      Specified by:
      getDeveloperName in interface CommonPluginInterface
      Returns:
      String containing the name of the developer. Cannot be null.

    • getContactEmail

      public String getContactEmail()
      Description copied from interface: CommonPluginInterface
      Returns the developer's contact email
      Specified by:
      getContactEmail in interface CommonPluginInterface
      Returns:
      String containing the developer's contact email. Cannot be null.

    • getVersion

      public String getVersion()
      Description copied from interface: CommonPluginInterface
      Returns the version number of the plugin
      Specified by:
      getVersion in interface CommonPluginInterface
      Returns:
      String containing the plugin version number. Cannot be null

    • getPamVerDevelopedOn

      public String getPamVerDevelopedOn()
      Description copied from interface: CommonPluginInterface
      The Pamguard version number that the plugin was developed on.
      Specified by:
      getPamVerDevelopedOn in interface CommonPluginInterface
      Returns:
      String containing the version number of Pamguard that the plugin was developed on. Cannot be null.

    • getPamVerTestedOn

      public String getPamVerTestedOn()
      Description copied from interface: CommonPluginInterface
      The Pamguard version number that the plugin has been tested on.
      Specified by:
      getPamVerTestedOn in interface CommonPluginInterface
      Returns:
      String containing the latest version of Pamguard that the plugin has been tested on. Cannot be null.

    • getAboutText

      public String getAboutText()
      Description copied from interface: CommonPluginInterface
      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.
      Specified by:
      getAboutText in interface CommonPluginInterface
      Returns:
      String containing a description of the plugin. Cannot be null

    • getDefaultName

      public String getDefaultName()
      Description copied from interface: CommonPluginInterface
      The default name of the plugin.

      This field cannot be null.

      Specified by:
      getDefaultName in interface CommonPluginInterface
      Returns:
      the default name of the plugin as a String. Cannot be null.