Class ClickTypeCommonParams

java.lang.Object
clickDetector.ClickClassifiers.ClickTypeCommonParams
All Implemented Interfaces:
Serializable, Cloneable, ManagedParameters
Direct Known Subclasses:
ClickTypeParams, SweepClassifierSet

public abstract class ClickTypeCommonParams extends Object implements Cloneable, Serializable, ManagedParameters
Superclass for click parameters, including the ClickTypeParms and SweepClassifierSet classes. Created to allow simple access to the alarm- specific parameters
Author:
Michael Oswald
See Also:
  • Field Details Link icon

    • serialVersionUID Link icon

      public static final long serialVersionUID
      See Also:
    • name Link icon

      protected String name
      The name of the classifier
    • speciesCode Link icon

      protected int speciesCode
      The species code of the classifier
    • discard Link icon

      protected Boolean discard
      True to discard classified clicks insteac of calssifiying them.
    • alarm Link icon

      protected ClickAlarm alarm
      Alarm to be used for detection
    • alarmEnabled Link icon

      protected Boolean alarmEnabled
      boolean indicating whether or not the alarm has been enabled
    • prevTime Link icon

      protected long prevTime
      the time (in milliseconds) of the previous detection
    • maxTime Link icon

      protected long maxTime
      the maximum amount of time allowed (in milliseconds) between clicks to still be counted as a detection (for alarm purposes)
  • Constructor Details Link icon

    • ClickTypeCommonParams Link icon

      public ClickTypeCommonParams()
  • Method Details Link icon

    • getAlarm Link icon

      public ClickAlarm getAlarm()
      Returns the ClickAlarm associated with this click type.
      Returns:
      the ClickAlarm
    • setAlarm Link icon

      public void setAlarm(ClickAlarm alarm)
      Sets the alarm used for this click type. This is used in the setupProcess() method of ClickDetector to reset a species code's alarm to the default alarm, in case the original alarm has been deleted.
      Parameters:
      clickAlarm - the clickAlarm to apply
    • getAlarmEnabled Link icon

      public Boolean getAlarmEnabled()
      Returns true/false on whether an alarm has been enabled for the click
      Returns:
      Boolean indicating status
    • setAlarmEnabled Link icon

      public void setAlarmEnabled(Boolean alarmEnabled)
    • getPrevTime Link icon

      public long getPrevTime()
    • setPrevTime Link icon

      public void setPrevTime(long prevTime)
    • getMaxTime Link icon

      public long getMaxTime()
    • setMaxTime Link icon

      public void setMaxTime(long maxTime)
    • clone Link icon

      protected ClickTypeCommonParams clone()
      Overrides:
      clone in class Object
    • getDiscard Link icon

      public Boolean getDiscard()
    • getName Link icon

      public String getName()
      Returns:
      the name
    • setName Link icon

      public void setName(String name)
      Parameters:
      name - the name to set
    • getSpeciesCode Link icon

      public int getSpeciesCode()
      Returns:
      the speciesCode
    • setSpeciesCode Link icon

      public void setSpeciesCode(int speciesCode)
      Parameters:
      speciesCode - the speciesCode to set
    • getEnable Link icon

      public boolean getEnable()
      Returns:
      the enable
    • getEnableObject Link icon

      public Boolean getEnableObject()
      Don't use this function. Use getEnable which will return a primitive and default to true. This is used for some startup checks to deal with a bug.
      Returns:
    • setEnable Link icon

      public void setEnable(boolean enable)
      Set enabled.
      Parameters:
      enable -
    • setDiscard Link icon

      public void setDiscard(Boolean discard)
      Parameters:
      discard - the discard to set
    • getParameterSet Link icon

      public PamParameterSet getParameterSet()
      Description copied from interface: ManagedParameters
      Get a set of data that describes all of the parameters in a class
      Specified by:
      getParameterSet in interface ManagedParameters
      Returns:
      description of the parameters in a class.