Package clickDetector

Class WignerPlot

java.lang.Object

Layout.PamFramePlots

clickDetector.ClickDisplay

clickDetector.WignerPlot

All Implemented Interfaces:

PamSettings, SettingsNameProvider

public class WignerPlot
extends ClickDisplay
implements PamSettings

Constructor Summary

Constructors

Constructor	Description
WignerPlot(ClickControl clickControl, ClickDisplayManager clickDisplayManager, clickDetector.ClickDisplayManager.ClickDisplayInfo clickDisplayInfo)
WignerPlot(STClickControl clickControl, ClickDisplayManager clickDisplayManager, clickDetector.ClickDisplayManager.ClickDisplayInfo clickDisplayInfo)	Constructor needed when creating the SoundTrap Click Detector - need to explicitly cast from STClickControl to ClickControl, or else constructor fails

Method Summary

Modifier and Type	Method	Description
void	clickedOnClick(ClickDetection click)
String	getName()	Get a unique name for the display
Serializable	getSettingsReference()
long	getSettingsVersion()
String	getUnitName()
String	getUnitType()
void	noteNewSettings()
boolean	restoreSettings(PamControlledUnitSettings pamControlledUnitSettings)
void	zoomFrequencyScale(int wheelRotation)

Methods inherited from class clickDetector.ClickDisplay

created, getClickDisplayInfo, offlineDataChanged, pamStart, pamStop

Methods inherited from class Layout.PamFramePlots

checkDualDisplay, getAxisPanel, getCopyMenuItem, getEastPanel, getFrame, getLeftPlotPanel, getNorthPanel, getPlotPanel, getRightPlotPanel, getSouthPanel, getWestPanel, repaint, setAxisPanel, setEastPanel, setFrame, setLeftPlotPanel, setNorthPanel, setPlotPanel, setRightPlotPanel, setSouthPanel, setWestPanel

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

WignerPlot

public WignerPlot(ClickControl clickControl,
 ClickDisplayManager clickDisplayManager,
 clickDetector.ClickDisplayManager.ClickDisplayInfo clickDisplayInfo)

WignerPlot

public WignerPlot(STClickControl clickControl,
 ClickDisplayManager clickDisplayManager,
 clickDetector.ClickDisplayManager.ClickDisplayInfo clickDisplayInfo)

Constructor needed when creating the SoundTrap Click Detector - need to explicitly cast from STClickControl to ClickControl, or else constructor fails

Parameters:

clickControl -

clickDisplayManager -

clickDisplayInfo -

Method Details

noteNewSettings

public void noteNewSettings()

Specified by:

noteNewSettings in class ClickDisplay

getName

public String getName()

Description copied from class: PamFramePlots

Get a unique name for the display

Specified by:

getName in class PamFramePlots

Returns:

a unique name for the display.

clickedOnClick

public void clickedOnClick(ClickDetection click)

Overrides:

clickedOnClick in class ClickDisplay

getSettingsReference

public Serializable getSettingsReference()

Specified by:

getSettingsReference in interface PamSettings

Returns:

The serialisable object that will be stored

zoomFrequencyScale

public void zoomFrequencyScale(int wheelRotation)

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