Package clickTrainDetector

Class ClickTrainProcess

java.lang.Object

PamguardMVC.PamProcess

clickTrainDetector.ClickTrainProcess

All Implemented Interfaces:

PamObserver, ProcessAnnotator

public class ClickTrainProcess
extends PamProcess

The core of the click train detector. Runs the click train detector on click detections.

Author:

Jamie Macaulay

Constructor Summary

Constructors

Constructor	Description
ClickTrainProcess(ClickTrainControl pamControlledUnit)

Method Summary

Modifier and Type	Method	Description
void	destroyProcess()	Called from the PamControlled unit when a PamControlled unit is removed from the model.
ClickTrainControl	getClickTrainControl()	Get the clcik trian controller.
ClickTrainDataBlock<CTDataUnit>	getClickTrainDataBlock()	Get the main click train output data block
ProcessCheck	getProcessCheck()	Get a process check object.
ClickTrainDataBlock<TempCTDataUnit>	getUnconfirmedCTDataBlock()	Get the temporary click train data block.
void	masterClockUpdate(long timeMilliseconds, long sampleNumber)
void	newClickData(PamDataUnit newClick)	New click detection has arrived.
void	newData(PamObservable o, PamDataUnit arg)
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.
void	setupProcess()	called for every process once the systemmodel has been created.

Methods inherited from class PamguardMVC.PamProcess

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

Methods inherited from class java.lang.Object

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

Constructor Details

ClickTrainProcess

public ClickTrainProcess(ClickTrainControl pamControlledUnit)

Method Details

destroyProcess

public void destroyProcess()

Description copied from class: PamProcess

Called from the PamControlled unit when a PamControlled unit is removed from the model. Offers an opportunity to disconnect individual processed from the rest of the model. May be necessary to override to clean up some processes.

Overrides:

destroyProcess in class PamProcess

setupProcess

public void setupProcess()

Description copied from class: PamProcess

called for every process once the systemmodel has been created. this is a good time to check out and find input data blocks and similar tasks.

Overrides:

setupProcess in class PamProcess

newData

public void newData(PamObservable o,
 PamDataUnit arg)

Overrides:

newData in class PamProcess

getProcessCheck

public ProcessCheck getProcessCheck()

Description copied from class: PamProcess

Get a process check object. This indicates the current status of a process.

Overrides:

getProcessCheck in class PamProcess

Returns:

the process check object.

newClickData

public void newClickData(PamDataUnit newClick)

New click detection has arrived.

Parameters:

click - - the new click

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

getClickTrainDataBlock

public ClickTrainDataBlock<CTDataUnit> getClickTrainDataBlock()

Get the main click train output data block

Returns:

- the click train output data block.

getUnconfirmedCTDataBlock

public ClickTrainDataBlock<TempCTDataUnit> getUnconfirmedCTDataBlock()

Get the temporary click train data block. This is used to store unconfirmed tracks for painting on displays.

Returns:

the temporary click train data block.

getClickTrainControl

public ClickTrainControl getClickTrainControl()

Get the clcik trian controller.

Returns:

the click train controlle.r

masterClockUpdate

public void masterClockUpdate(long timeMilliseconds,
 long sampleNumber)

Specified by:

masterClockUpdate in interface PamObserver

Overrides:

masterClockUpdate in class PamProcess