smlPingerControl

Class SMLPingerControl

java.lang.Object

PamController.PamControlledUnit

smlPingerControl.SMLPingerControl

All Implemented Interfaces:

PamSettings

public class SMLPingerControl
extends PamControlledUnit
implements PamSettings

Constructor Summary

Constructors

Constructor and Description
SMLPingerControl(java.lang.String unitName)

Method Summary

Methods

Modifier and Type	Method and Description
javax.swing.JMenuItem	createDetectionMenu(java.awt.Frame parentFrame) Create a JMenu object containing MenuItems associated with PamProcesses
SMLPingerParams	getPingerParams()
SMLPingerProcess	getPingerProcess()
java.io.Serializable	getSettingsReference()
long	getSettingsVersion()
PingerSidePanel	getSidePanel() Gets a reference to a small panel to be displayed along the left hand edge of the main tab panel.
int	getVerboseLevel()
void	newStatusData(SMLStatusData status) Called whenever new status data are read from the serial port by pingerPorcess
void	notifyModelChanged(int changeType) General notification when the PAMGAURD model changes.
void	pingerSettings(java.awt.Frame parentFrame)
void	portError() Report a port error
boolean	restoreSettings(PamControlledUnitSettings pamControlledUnitSettings)
void	setRunMode(int runMode) Called from the side panel when a new run mode is selected

Methods inherited from class PamController.PamControlledUnit

addOfflineTaskGroup, addOtherRelatedMenuItems, addPamProcess, addRelatedMenuItems, addXMLParameter, addXMLParameter, addXMLParameter, addXMLParameter, canClose, canPlayViewerSound, createDisplayMenu, createFileMenu, createHelpMenu, fillXMLElement, flushDataBlockBuffers, getFrameNumber, getGuiFrame, getModuleSummary, getNumOfflineTaskGroups, getNumPamProcesses, getOfflineTaskGroup, getPamController, getPamModuleInfo, getPamProcess, getPamView, getShortUnitType, getTabClipCopier, getTabPanel, getTabSpecificMenuBar, getToolbarComponent, getUnitName, getUnitType, gotoTab, isViewer, pamClose, pamHasStopped, pamToStart, playViewerSound, removePamProcess, removeUnit, rename, saveViewerData, setFrameNumber, setPamController, setPamModuleInfo, setPamView, setSidePanel, setTabPanel, setupControlledUnit, stopViewerSound, terminalPrint, terminalPrintln, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface PamController.PamSettings

getUnitName, getUnitType

Constructor Detail

SMLPingerControl

public SMLPingerControl(java.lang.String unitName)

Method Detail

getSidePanel

public PingerSidePanel getSidePanel()

Description copied from class: PamControlledUnit

Gets a reference to a small panel to be displayed along the left hand edge of the main tab panel. Side panels should be small since they are always visible and any space they take will be taken from the main tab panel.

It is possible for a PamControlled unit to have a side panel without having a pamTabPanel.

Overrides:

getSidePanel in class PamControlledUnit

Returns:

a pamSidePanel object.

See Also:

PamSidePanel, PamTabPanel

getPingerProcess

public SMLPingerProcess getPingerProcess()

Returns:

the pingerProcess

getSettingsReference

public java.io.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

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

createDetectionMenu

public javax.swing.JMenuItem createDetectionMenu(java.awt.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.

pingerSettings

public void pingerSettings(java.awt.Frame parentFrame)

newStatusData

public void newStatusData(SMLStatusData status)

Called whenever new status data are read from the serial port by pingerPorcess

Parameters:

status - status data

getPingerParams

public SMLPingerParams getPingerParams()

Returns:

the pingerParams

setRunMode

public void setRunMode(int runMode)

Called from the side panel when a new run mode is selected

Parameters:

runMode - (0 - 4 see SMLPingerParams

notifyModelChanged

public void notifyModelChanged(int changeType)

Description copied from class: PamControlledUnit

General notification when the PAMGAURD model changes.

Overrides:

notifyModelChanged in class PamControlledUnit

Parameters:

changeType - type of change

portError

public void portError()

Report a port error

getVerboseLevel

public int getVerboseLevel()

Overrides:

getVerboseLevel in class PamControlledUnit

Returns:

a verbose level for terminalPrint and terminalPrintln