Package effortmonitor

Class EffortControl

java.lang.Object

PamController.PamControlledUnit

effortmonitor.EffortControl

All Implemented Interfaces:

PamSettings, SettingsNameProvider

public class EffortControl
extends PamControlledUnit
implements PamSettings

Record scroll effort.

Author:

dg50

Field Summary

Fields

Modifier and Type	Field	Description
static String	unitType

Constructor Summary

Constructors

Constructor	Description
EffortControl(String unitName)

Method Summary

Modifier and Type	Method	Description
void	addObserver(EffortObserver observer)	Add something that wants notificatins when status changes
JMenuItem	createDetectionMenu(Frame parentFrame)	Create a JMenu object containing MenuItems associated with PamProcesses
EffortDataMapGraph	getDataMapGraph()
PamDataBlock<EffortDataUnit>	getEffortDataBlock()
EffortParams	getEffortParams()
Serializable	getSettingsReference()
long	getSettingsVersion()
PamSidePanel	getSidePanel()	Gets a reference to a small panel to be displayed along the left hand edge of the main tab panel.
void	goToTime(AbstractPamScroller scroller, long timeInMilliseconds)
boolean	isOnEffort()	Is recording effort
void	notifyModelChanged(int changeType)	General notification when the PAMGAURD model changes.
void	notifyObservers()
boolean	removeObserver(EffortObserver observer)	Remove an effort observer
boolean	restoreSettings(PamControlledUnitSettings pamControlledUnitSettings)
void	setOnEffort(boolean selected)	Set that is recording effort.
boolean	showSettingsDialog(Frame parentFrame, EffortDataUnit existingUnit)

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, getTabClipCopier, getTabPanel, getTabSpecificMenuBar, getToolbarComponent, getUnitName, getUnitType, getVerboseLevel, gotoTab, isInMainConfiguration, isNetRx, isViewer, pamClose, pamHasStopped, pamToStart, playViewerSound, removePamProcess, removeUnit, rename, saveViewerData, setFrameNumber, setModuleStatusManager, setPamConfiguration, setPamController, setPamModuleInfo, setPamView, setSidePanel, setTabPanel, setToolbarComponent, setupControlledUnit, 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

Field Details

unitType

public static String unitType

Constructor Details

EffortControl

public EffortControl(String unitName)

Method Details

getSidePanel

public PamSidePanel 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

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

getEffortDataBlock

public PamDataBlock<EffortDataUnit> getEffortDataBlock()

getEffortParams

public EffortParams getEffortParams()

Returns:

the effortParams

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.

showSettingsDialog

public boolean showSettingsDialog(Frame parentFrame,
 EffortDataUnit existingUnit)

goToTime

public void goToTime(AbstractPamScroller scroller,
 long timeInMilliseconds)

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

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

addObserver

public void addObserver(EffortObserver observer)

Add something that wants notificatins when status changes

Parameters:

observer -

removeObserver

public boolean removeObserver(EffortObserver observer)

Remove an effort observer

Parameters:

observer -

Returns:

notifyObservers

public void notifyObservers()

setOnEffort

public void setOnEffort(boolean selected)

Set that is recording effort.

Parameters:

selected -

isOnEffort

public boolean isOnEffort()

Is recording effort

Returns:

getDataMapGraph

public EffortDataMapGraph getDataMapGraph()

Returns:

the dataMapGraph