Package PamController

Interface PamSettings

All Superinterfaces:
SettingsNameProvider
All Known Implementing Classes:
AcquisitionControl, AirgunControl, AISControl, AlarmControl, AlarmSerialInterface, AlarmUDPAction, AmpControl, AnalogDevicesManager, AngleMeasurement, AngleVetoes, AnnotationDataSelCreator, ArchiveModelClassifier, ArrayAccelControl, ArrayManager, ArraySensorComponent, ArraySensorControl, ArraySidePanelControl, ASIOSoundSystem, AzigramControl, BackupManager, BackupStream, BasicClickIdentifier, BeamformControl, BeamFormerControl, BeamFormLocaliserControl, BearingLocaliserControl, BespokeBackups, BespokeFileStream, BinaryBackupStream, BinaryStore, BrainBoxDevices, BuoyDataSerialiser, CalendarControl, CBLocaliserControl, CepstrumControl, CircularMovement, ClassifierDataSelCreator, ClickAlarmCounter, ClickBTDisplay, ClickControl, ClickDataSelectCreator, ClickDetSymbolManager, ClickDisplayManager, ClickEventSymbolManager, ClickSpectrum, ClickTOADCalculator, ClickTrainControl, ClickTrainDataSelectorCreator, ClickTrainDetector, ClickTrainSymbolManager, ClipControl, ClipDisplayPanel, ClipSymbolManager, ConcatenatedSpectrogram, ControlDataSelCreator, CPODControl, CPODControl2, CPODDataSelectorCreator, CPODSymbolManager, CPODTrainSymbolManager, CTDataSelectCreator, CyclicColourSymbolManager, DatabaseBackupStream, DataKeeper, DataMapControl, DataMapSymbolManager, DataModelSettingsManager, DataSelectorCreator, DBControl, DBControlSettings, DBControlUnit, DbHtAlarmCounter, DbHtControl, DCL5System, DecimatorControl, DelphinIDClassifier, DepthControl, DetectionGroupControl, DetectionGroupDisplayFX, DetectionGroupSymbolManager, DifarControl, DifarDataSelectCreator, DLControl, DLDataSelectCreator, DLSymbolManager, EffortControl, EnergySumControl, EnvelopeControl, EnvelopeTracer, ExportOptions, ExternalDatabaseControl, FFTPluginPanelProvider.FFTPluginPanel, FileBackupStream, FileInputSystem, FilterControl, FluxgateWorldAngles, FolderInputSystem, FormDataSelCreator, FormsControl, FormsDataSelectorCreator, FormSettingsControl, GenericDLClassifier, GenericTOADCalculator, GlobalMediumManager, GlobalTimeManager, GPLControlledUnit, GPLSymbolManager, GPSControl, GpsEffortSymbolManager, GreenridgeDemux, Grid3D, GridbaseControl, GridMovement, Group3DDataSelectCreator, Group3DLocaliserControl, Group3DSymbolManager, GuiFrameManager, HidingPanel, icListenSystem, IDI_Display, IMUControl, IshDetControl, IshDetGraphics, IshLocControl, IshmaelDataControl, JamieEchoDetectionSystem, KernelSmoothingControl, KetosClassifier, KetosClassifier2, KooguClassifier, LandmarkControl, LevelMeterControl, LikelihoodDetectionUnit, ListeningControl, LoggerSymbolManager, LookupDataSelCreator, LtsaControl, ManualAnnotationHandler, MapController, MapDetectionsManager, MapGroupLocaliserControl, MarkovChain, MarkRelationships, MatchFiltControl, MCCAnalogDevices, MCCDaqSystem, MccDepthSystem, MetaDataContol, MHTClickTrainAlgorithm, MSAccessSystem, MTClassifierControl, MySQLSystem, NativeDemux, NetworkEmulator, NetworkReceiver, NetworkSender, NewAsioSoundSystem, NIDAQProcess, NIFilePlayback, NINetworkDaq, NMEAControl, NoiseAlarmCounter, NoiseBandControl, NoiseControl, NullDataSelectorCreator, OfflineFileServer, OfflineTaskGroup, OfflineWavFileServer, OneBandAlarmCounter, OneBandControl, OneStopAnnotationHandler, OrcaSpotClassifier, PamColors, PamColorsFX, PamController, PamFFTControl, PamguardXMLWriter, PamGui, PamGuiManagerFX, PamModel, PamNMEATime, PamNTPTime, PamObjectViewer, PamOldSymbolManager, PamSplitPane, PamSymbolManager, PamTempSettings, PamZipModelClassifier, PatchPanelControl, PlaybackControl, PlaySound, PostgreSQLSystem, PredictionSymbolManager, PrintScreenControl, QAAnalyser, QAControl, QuickAnnotationModule, RadarDisplay, RavenControl, RawDataDisplay.RawDisplayPanel, RecorderBackupStream, RecorderControl, RefractionMethod, RoccaControl, RockBlockControl, RonaInputSystem, RonaOfflineFileServer, RWDataSelCreator, RWEControl, RWESymbolManager, ScalarDataSelCreator, ScrollerCoupling, ScrollJumper, SecondaryBinaryStore, SendEmailAction, ServerBasedSystem, SgramCorrControl, SimpleEchoDetectionSystem, SimpleMap, SimProcess, SmruDaqSystem, SNRDataSelCreator, SoundCardSystem, SoundSpotClassifier, SpeciesMapManager, SpectrogramAnnotationModule, SpectrogramDisplay, SpectrogramNoiseControl, SpectrogramScrollJumper, SphericalGrid, SplitPanePositioner, SqliteSystem, STAcquisitionControl, StandardClassifierModel, StandardFileDate, StandardSymbolManager, STClickControl, StorageOptions, STToolsControl, SudAudioFile, SuperDetectionSymbolManager, SweepClassifier, SwingTableColumnWidths, SymbolOnlyManager, TabbedHidingPane.TabHidingPanel, TargetMotionControl, TDAcousticScroller, TDControl, TDControl, TDControlAWT, TDControlFX, TethysControl, TowedArray3DController, UCanAccessSystem, UnconfirmedCTSymbolManager, UserDisplayControl, UserFormDataSelCreator, VetoController, ViewerScrollerManager, VRControl, WarnOnce, WhistleClassifierControl, WhistleControl, WhistleMoanControl, WhistleSymbolManager, WignerPlot, WMAlarmCounter, WMDDataSelectCreator, WslClsDataSelectCreator, WSLToadCalculator, ZipUnpacker
public interface PamSettings extends SettingsNameProvider
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 Details

    • getUnitType

      String getUnitType()
      Returns:
      A Name specific to the type, e.g. Click detector

    • getSettingsReference

      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