PamController
Interface PamSettings

All Known Implementing Classes:

AcquisitionControl, AirgunControl, AISControl, AmpControl, AngleMeasurement, AngleVetoes, ArrayManager, ASIOSoundSystem, BasicClickIdentifier, BeakedControl, BinaryStore, ClickBTDisplay, ClickControl, ClickDisplayManager, ClickSpectrum, DataMapControl, DBControl, DBControlSettings, DBControlUnit, DecimatorControl, DepthControl, EdgeControl, EnergySumControl, FFTPluginPanelProvider.FFTPluginPanel, FileInputSystem, FilterControl, FluxgateWorldAngles, FolderInputSystem, GPSControl, GuiFrameManager, IshDetControl, IshLocControl, IshmaelDataControl, KernelSmoothingControl, LandmarkControl, LikelihoodDetectionUnit, ListeningControl, MapController, MapDetectionsManager, MatchFiltControl, MccDepthSystem, MSAccessSystem, MySQLSystem, NIDAQProcess, NMEAControl, NoiseControl, OfflineFileServer, PamColors, PamController, PamController.ViewTimesSettings, PamFFTControl, PamGui, PamModel, PamObjectViewer, PamSymbolManager, PatchPanelControl, PlaybackControl, RawDataDisplay.RawDisplayPanel, RecorderControl, RefractionMethod, RoccaControl, SgramCorrControl, SimProcess, SoundCardSystem, SpectrogramNoiseControl, SweepClassifier, TerrellaControl, TowedArray3DController, TriggerFunctionDisplay.TriggerFunctionDisplayPanel, UserDisplayControl, VetoController, ViewerScrollerManager, VRControl, WhistleClassifierControl, WhistleControl, WhistleMoanControl, WhitesWhistleControl, WignerPlot, WorkshopController

public interface PamSettings

Author:

Doug Gillespie

Implement this in any class that has settings you want to store between runs.

A class implementing PamSettings must register itself with the settings manager with a call such as

PamSettingManager.getInstance().RegisterSettings(this);

Method Summary

java.io.Serializable	getSettingsReference()
long	getSettingsVersion()
java.lang.String	getUnitName()
java.lang.String	getUnitType()
boolean	restoreSettings(PamControlledUnitSettings pamControlledUnitSettings)

Method Detail

getUnitName

java.lang.String getUnitName()

Returns:

A Name specific to this instance of the particular class, e.g. Sperm whale detector, Beaked whale detector, etc.

getUnitType

java.lang.String getUnitType()

Returns:

A Name specific to the type, e.g. Glick detector

getSettingsReference

java.io.Serializable getSettingsReference()

Returns:

The serialisable object that will be stored

getSettingsVersion

long getSettingsVersion()

Returns:

An integer version number for the settings

restoreSettings

boolean restoreSettings(PamControlledUnitSettings pamControlledUnitSettings)

Parameters:

pamControlledUnitSettings -

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