Package mapgrouplocaliser

Class MarkGroupProcess

java.lang.Object

PamguardMVC.PamProcess

mapgrouplocaliser.MarkGroupProcess

All Implemented Interfaces:

PamObserver, ProcessAnnotator, OverlayMarkObserver

public class MarkGroupProcess
extends PamProcess
implements OverlayMarkObserver

Field Summary

Fields inherited from class PamguardMVC.PamProcess

outputDataBlocks, parentDataBlock, processName, sampleRate

Fields inherited from interface PamView.paneloverlay.overlaymark.OverlayMarkObserver

MARK_CANCELLED, MARK_END, MARK_START, MARK_UPDATE, MOUSE_CLICK

Constructor Summary

Constructors

Constructor	Description
MarkGroupProcess(MapGroupLocaliserControl markGroupLocaliser)

Method Summary

Modifier and Type	Method	Description
MarkDataSelector	getMarkDataSelector(OverlayMarker overlayMarker)	Get a data selector for use with a specific type of mark.
MarkGroupDataBlock	getMarkGroupDataBlock()
MarkGroupSQLLogging	getMarkGroupSQLLogging()
String	getMarkName()	Name of the mark.
JPopupMenu	getPopupMenuItems(DetectionGroupSummary markSummaryData)	Get a menu, or menu items which can be used to display on the marking display in response to a right click or some other action.
GeneralProjector.ParameterType[]	getRequiredParameterTypes()	Required parameters for the mark to get used.
boolean	markUpdate(int markStatus, javafx.scene.input.MouseEvent mouseEvent, OverlayMarker overlayMarker, OverlayMark overlayMark)	Mark update called whenever a mark changes
void	pamStart()	Called for each process to tell it to start (may not be necessary for processes which are listening for data anyway).
void	pamStop()	Stops the process.

Methods inherited from class PamguardMVC.PamProcess

absMillisecondsToSamples, absSamplesToMilliseconds, addData, addMultiPlexDataBlock, addOutputDataBlock, changedThreading, clearOldData, createAnnotations, destroyProcess, dumpBufferStatus, flushDataBlockBuffers, getAncestorDataBlock, getAnnotation, getChainPosition, getCompatibleDataUnits, getCpuPercent, getFrequencyRange, getLastSourceNotificationObject, getLastSourceNotificationType, getMuiltiplexDataBlock, getNumAnnotations, getNumMuiltiplexDataBlocks, getNumOutputDataBlocks, getObserverName, getObserverObject, getOfflineData, getOfflineData, getOutputDataBlock, getOutputDataBlocks, getPamControlledUnit, getParentDataBlock, getParentDataBlocks, getParentProcess, getProcessCheck, getProcessName, getRawSourceDataBlock, getRawSourceDataBlock, getRequiredDataHistory, getSampleRate, getSourceDataBlock, getSourceProcess, hasOutputDatablock, isCanMultiThread, isExternalProcess, isMultiplex, makePamProcess, masterClockUpdate, newData, noteNewSettings, notifyModelChanged, prepareProcess, prepareProcessOK, processNewBuoyData, receiveSourceNotification, relMillisecondsToSamples, relSamplesToMilliseconds, removeAllDataBlocks, removeAllMultiPlexDataBlocks, removeMultiPlexDataBlock, removeObservable, removeOutputDatablock, resetDataBlocks, saveViewerData, setCanMultiThread, setExternalProcess, setMultiplex, setParentDataBlock, setParentDataBlock, setProcessCheck, setProcessName, setSampleRate, setupProcess, toString, updateData

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface PamView.paneloverlay.overlaymark.OverlayMarkObserver

getObserverName

Constructor Details

MarkGroupProcess

public MarkGroupProcess(MapGroupLocaliserControl markGroupLocaliser)

Method Details

pamStart

public void pamStart()

Description copied from class: PamProcess

Called for each process to tell it to start (may not be necessary for processes which are listening for data anyway).

Specified by:

pamStart in class PamProcess

pamStop

public void pamStop()

Description copied from class: PamProcess

Stops the process.

Specified by:

pamStop in class PamProcess

markUpdate

public boolean markUpdate(int markStatus,
 javafx.scene.input.MouseEvent mouseEvent,
 OverlayMarker overlayMarker,
 OverlayMark overlayMark)

Description copied from interface: OverlayMarkObserver

Mark update called whenever a mark changes

Specified by:

markUpdate in interface OverlayMarkObserver

Parameters:

markStatus - start, end, update, cancel, etc.

overlayMarker - Source of the mark (generally a display)

overlayMark - updated mark.

Returns:

true if the observer has used the mark.

getMarkGroupSQLLogging

public MarkGroupSQLLogging getMarkGroupSQLLogging()

Returns:

the markGroupSQLLogging

getRequiredParameterTypes

public GeneralProjector.ParameterType[] getRequiredParameterTypes()

Description copied from interface: OverlayMarkObserver

Required parameters for the mark to get used. Can be null in which case the mark can accept anything, might be something like TIME invalid input: '&' FREQUENCY, etc.

Specified by:

getRequiredParameterTypes in interface OverlayMarkObserver

Returns:

list of parameters (up to three).

getPopupMenuItems

public JPopupMenu getPopupMenuItems(DetectionGroupSummary markSummaryData)

Description copied from interface: OverlayMarkObserver

Get a menu, or menu items which can be used to display on the marking display in response to a right click or some other action.

The menu items will be put into a popup menu for display.

Specified by:

getPopupMenuItems in interface OverlayMarkObserver

Parameters:

markSummaryData - everything we need to know about the mark, including which data are within it.

Returns:

A menu item (can be null)

getMarkDataSelector

public MarkDataSelector getMarkDataSelector(OverlayMarker overlayMarker)

Description copied from interface: OverlayMarkObserver

Get a data selector for use with a specific type of mark.

Specified by:

getMarkDataSelector in interface OverlayMarkObserver

Parameters:

overlayMarker - Marker

Returns:

Data selector (can be null)

getMarkName

public String getMarkName()

Description copied from interface: OverlayMarkObserver

Name of the mark. Observers may have several mark types and might want to change the name to indicate what action will be taken when a mark is made

Specified by:

getMarkName in interface OverlayMarkObserver

Returns:

getMarkGroupDataBlock

public MarkGroupDataBlock getMarkGroupDataBlock()

Returns:

the markGroupDataBlock