PamSettings

All Known Implementing Classes:

AcquisitionControl, AirgunControl, AISControl, AlarmControl, AlarmSerialInterface, AmpControl, AngleMeasurement, AngleVetoes, ArrayAccelControl, ArrayManager, ASIOSoundSystem, BasicClickIdentifier, BasicResultFilter, BeakedControl, BinaryStore, ClickAlarmCounter, ClickBTDisplay, ClickControl, ClickDataSelector, ClickDisplayManager, ClickLocaliserControl, ClickSpectrum, ClipControl, ClipDisplayPanel, CPODControl, DataMapControl, DBControl, DBControlSettings, DBControlUnit, DbHtAlarmCounter, DbHtControl, DCL5System, DecimatorControl, DepthControl, DifarControl, DifarDataSelector, DStrControl, EchoController, EdgeControl, EnergySumControl, EnvelopeControl, FFTPluginPanelProvider.FFTPluginPanel, FileInputSystem, FilterControl, FluxgateWorldAngles, FolderInputSystem, FormSettingsControl, GPSControl, GreenridgeDemux, GridMovement, GuiFrameManager, HyperboleLoc, IDI_Display, IMUControl, IpiController, IpiPluginPanelProvider.IpiPluginPanel, IshDetControl, IshLocControl, IshmaelDataControl, JamieEchoDetectionSystem, KernelSmoothingControl, LandmarkControl, LevelMeterControl, LikelihoodDetectionUnit, ListeningControl, LtsaControl, MapDetectionsManager, MarkovChain, MarkovChain, MarkovChainSL, MarkovChainSLHM, MatchFiltControl, MccDepthSystem, MSAccessSystem, MySQLSystem, NativeDemux, NetworkEmulator, NetworkReceiver, NetworkSender, NewAsioSoundSystem, NIDAQProcess, NMEAControl, NoiseAlarmCounter, NoiseBandControl, NoiseControl, OfflineFileServer, OfflineTaskGroup, OneBandAlarmCounter, OneBandControl, OOoDBSystem, PamColors, PamController, PamFFTControl, PamGui, PamModel, PamObjectViewer, PamSymbolManager, PatchPanelControl, PlaybackControl, PlaySound, RawDataDisplay.RawDisplayPanel, RecorderControl, RefractionMethod, RoccaControl, RonaInputSystem, RonaOfflineFileServer, RWEControl, SerialLogger, SgramCorrControl, SimpleEchoDetectionSystem, SimpleMap, SimProcess, SMLGainControl, SMLPingerControl, SmruDaqSystem, SoundCardSystem, SpectrogramNoiseControl, StaticLocaliserControl, StorageOptions, SweepClassifier, TargetMotionControl, TDControl, TowedArray3DController, UCanAccessSystem, UserDisplayControl, VetoController, ViewerScrollerManager, VRControl, WhistleClassifierControl, WhistleControl, WhistleMoanControl, WignerPlot, WILDControl, WMAlarmCounter, WMDDataSelector, WorkshopController, XBatLogControl, ZipUnpacker
```
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

Methods
Modifier and Type	Method and Description
`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

Interface PamSettings

Method Summary

Method Detail

getUnitName

getUnitType

getSettingsReference

getSettingsVersion

restoreSettings