Package IshmaelLocator

Class IshLocControl

java.lang.Object

PamController.PamControlledUnit

IshmaelLocator.IshLocControl

All Implemented Interfaces:

PamSettings, SettingsNameProvider

public class IshLocControl
extends PamControlledUnit
implements PamSettings

This implements the two locators from Ishmael. One, namely IshLocPairProcess, calculates a bearing from 2 phones. The other calculates a 2- or 3-D position from N phones using a least-squares minimization process.

Author:

Dave Mellinger and Hisham Qayum

Constructor Summary

Constructors

Constructor	Description
IshLocControl(String unitName)

Method Summary

Modifier and Type	Method	Description
JMenuItem	createDetectionMenu(Frame parentFrame)	Create a JMenu object containing MenuItems associated with PamProcesses
IshLocProcess	getProcess()
Serializable	getSettingsReference()
long	getSettingsVersion()
boolean	restoreSettings(PamControlledUnitSettings settings)	This is called after a settings file is read.
void	setupControlledUnit()	called for all PamControlledUnits after all units have been created.

Methods inherited from class PamController.PamControlledUnit

addOfflineTaskGroup, addOtherRelatedMenuItems, addPamProcess, addPamProcess, addRelatedMenuItems, canClose, canPlayViewerSound, createDisplayMenu, createFileMenu, createHelpMenu, flushDataBlockBuffers, getBackupInformation, getFrameNumber, getGUI, getGuiFrame, getInstanceIndex, getModuleStatus, getModuleStatusManager, getModuleSummary, getModuleSummary, getNumOfflineTaskGroups, getNumPamProcesses, getOfflineState, getOfflineTaskGroup, getPamConfiguration, getPamController, getPamModuleInfo, getPamProcess, getPamView, getPlugin, getShortUnitType, getSidePanel, getTabClipCopier, getTabPanel, getTabSpecificMenuBar, getToolbarComponent, getUnitName, getUnitType, getVerboseLevel, gotoTab, isInMainConfiguration, isNetRx, isViewer, notifyModelChanged, pamClose, pamHasStopped, pamToStart, playViewerSound, removePamProcess, removeUnit, rename, saveViewerData, setFrameNumber, setModuleStatusManager, setPamConfiguration, setPamController, setPamModuleInfo, setPamView, setSidePanel, setTabPanel, setToolbarComponent, stopViewerSound, tellModule, terminalPrint, terminalPrintln, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface PamController.PamSettings

getUnitType

Methods inherited from interface PamController.SettingsNameProvider

getUnitName

Constructor Details

IshLocControl

public IshLocControl(String unitName)

Method Details

setupControlledUnit

public void setupControlledUnit()

Description copied from class: PamControlledUnit

called for all PamControlledUnits after all units have been created. This is a good time for the controlled units and processes to find and check their source data and the configuration generally since most onjects (i.e. output data blocks) should be in place

Overrides:

setupControlledUnit in class PamControlledUnit

createDetectionMenu

public JMenuItem createDetectionMenu(Frame parentFrame)

Description copied from class: PamControlledUnit

Create a JMenu object containing MenuItems associated with PamProcesses

Overrides:

createDetectionMenu in class PamControlledUnit

Parameters:

parentFrame - The owner frame of the menu

Returns:

reference to a JMenu which can be added to an existing menu or menu bar

Note that if multiple views are to use the same menu, then they should each create a new menu (by setting Create to true) the first time they call this method.

restoreSettings

public boolean restoreSettings(PamControlledUnitSettings settings)

This is called after a settings file is read. The subclass should get newParams and clone it as ishDetParams before calling here.

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

getSettingsReference

public Serializable getSettingsReference()

Specified by:

getSettingsReference in interface PamSettings

Returns:

The serialisable object that will be stored

getSettingsVersion

public long getSettingsVersion()

Specified by:

getSettingsVersion in interface PamSettings

Returns:

An integer version number for the settings

getProcess

public IshLocProcess getProcess()

Returns:

a PamProcess (hyperb or pair loc) for this control