Package clickDetector

Class ClickAlarm

java.lang.Object
clickDetector.ClickAlarm
All Implemented Interfaces:
Serializable, Cloneable, Comparable<ClickAlarm>, ManagedParameters
public class ClickAlarm extends Object implements Comparable<ClickAlarm>, Serializable, Cloneable, ManagedParameters
Alarm object for the Click Alarm
Author:
Michael Oswald
See Also:

  • Field Details

    • serialVersionUID

      public static final long serialVersionUID
      for serialization
      See Also:

    • DEFAULTNAME

      public static final String DEFAULTNAME
      Default alarm name
      See Also:

    • DEFAULTDING

      public static final String DEFAULTDING
      Default alarm sound

  • Constructor Details

    • ClickAlarm

      public ClickAlarm()
      Constructor with no passed name - just use the default name

    • ClickAlarm

      public ClickAlarm(String name)
      Constructor used to set the name of the new alarm. Defaults to the DEFAULTDING constant, and loads it right away

  • Method Details

    • getUserAlarmFile

      public String getUserAlarmFile()

    • setUserAlarmFile

      public void setUserAlarmFile(String userAlarmFile)

    • useDefault

      public boolean useDefault()
      Check if we're using the default sound file for the alarm. True indicates this alarm uses the default sound file. False indicates this alarm uses a user-defined sound file.

    • selectDefault

      public void selectDefault(boolean defaultSoundFlag)

    • getName

      public String getName()

    • setName

      public void setName(String name)

    • loadAlarm

      public boolean loadAlarm()

    • isFileLoaded

      public boolean isFileLoaded()

    • setFileLoaded

      public void setFileLoaded(boolean fileIsLoaded)

    • getClickClip

      public Clip getClickClip()

    • clone

      public ClickAlarm clone()

    • getSerialVersionUID

      public static long getSerialVersionUID()

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • compareTo

      public int compareTo(ClickAlarm alarm)
      Specified by:
      compareTo in interface Comparable<ClickAlarm>

    • getParameterSet

      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.