Package depthReadout

Class MccDepthSystem

java.lang.Object
depthReadout.MccDepthSystem
All Implemented Interfaces:
DepthSystem, PamSettings, SettingsNameProvider
public class MccDepthSystem extends Object implements DepthSystem, PamSettings

  • Constructor Details

    • MccDepthSystem

      public MccDepthSystem(DepthControl depthControl)

  • Method Details

    • canConfigure

      public boolean canConfigure()
      Description copied from interface: DepthSystem
      Say whether ot not a particular sensor can be configured.
      Specified by:
      canConfigure in interface DepthSystem
      Returns:
      true if the sensor can be configured

    • configureSensor

      public boolean configureSensor(Frame parentFrame)
      Description copied from interface: DepthSystem
      Configure one of the sensors.
      Specified by:
      configureSensor in interface DepthSystem
      Parameters:
      parentFrame - owner frame for dialog
      Returns:
      true if configurations went Ok.

    • readSensor

      public boolean readSensor(int iSensor)
      Description copied from interface: DepthSystem
      Read all data from a sensor. These data should be stored locally in the concrete class and will then be retreived with other get... functions.
      Specified by:
      readSensor in interface DepthSystem
      Parameters:
      iSensor - number of the sensor
      Returns:
      true if the read went OK.

    • getDepthRawData

      public double getDepthRawData(int iSensor)
      Description copied from interface: DepthSystem
      Get the depth (should be in meters)
      Specified by:
      getDepthRawData in interface DepthSystem
      Returns:
      depth in meters. or DEPTH_OUT_OF_RANGE or DEPTH_NO_DATA

    • getDepth

      public double getDepth(int iSensor)
      Description copied from interface: DepthSystem
      Get the depth (should be in meters)
      Specified by:
      getDepth in interface DepthSystem
      Returns:
      depth in meters. or DEPTH_OUT_OF_RANGE or DEPTH_NO_DATA

    • shouldPoll

      public boolean shouldPoll()
      Description copied from interface: DepthSystem
      DepthProcess should ask this system for data every so often if this return false, then the data are comign from somewhere beyond the immediate contron of Pamgaurd and we just wait for it to arrive.
      Specified by:
      shouldPoll in interface DepthSystem
      Returns:
      true if the sensor needs to be polled.

    • 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

    • 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

    • 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