Package detectiongrouplocaliser

Class DetectionGroupDataBlock

java.lang.Object

PamguardMVC.PamObservable

PamguardMVC.PamDataBlock<DetectionGroupDataUnit>

PamguardMVC.superdet.SuperDetDataBlock<DetectionGroupDataUnit,PamDataUnit>

detectiongrouplocaliser.DetectionGroupDataBlock

public class DetectionGroupDataBlock
extends SuperDetDataBlock<DetectionGroupDataUnit,PamDataUnit>

Nested Class Summary

Nested classes/interfaces inherited from class PamguardMVC.superdet.SuperDetDataBlock

SuperDetDataBlock.ViewerLoadPolicy

Field Summary

Fields inherited from class PamguardMVC.PamDataBlock

ITERATOR_END, MATCH_AFTER, MATCH_BEFORE, MATCH_EXACT, MIX_DONOTHING, MIX_INTODATABASE, MIX_OUTOFDATABASE, naturalLifetime, NOTIFY_NEW_DATA, NOTIFY_UPDATE_DATA, pamDataUnits, parentProcess, POSITION_AFTER, POSITION_BEFORE, REFERENCE_ABSOLUTE, REFERENCE_CURRENT, REQUEST_DATA_LOADED, REQUEST_DATA_PARTIAL_LOAD, REQUEST_EXCEPTION, REQUEST_INTERRUPTED, REQUEST_NO_DATA, REQUEST_SAME_REQUEST, unitsAdded, unitsRemoved, unitsUpdated

Fields inherited from class PamguardMVC.PamObservable

masterClockSample, objectChanged, overlayDraw, pamProfiler

Constructor Summary

Constructors

Constructor	Description
DetectionGroupDataBlock(String dataName, DetectionGroupControl detectionGroupControl, DetectionGroupProcess detectionGroupProcess)

Method Summary

Modifier and Type	Method	Description
void	addPamData(DetectionGroupDataUnit pamDataUnit)	Adds a new PamDataUnit to the PamDataBlock.
void	addPamData(DetectionGroupDataUnit pamDataUnit, Long uid)	Adds a new PamDataUnit to the PamDataBlock and force the UID to a specific value.
boolean	canSuperDetection(PamDataBlock subDataBlock)	Return whether this type of super detection can hold the passed sub detection data.
void	clearAll()	Clears all PamDataUnits from memory
DataBlockSpeciesManager<DetectionGroupDataUnit>	getDatablockSpeciesManager()	Get information about species types that may occur within this data block.
TethysDataProvider	getTethysDataProvider(TethysControl tethysControl)	Gets a data provider for Tethys.
boolean	needViewerDataLoad(OfflineDataLoadInfo offlineDataLoadInfo)	Do we need to reload offline data ? Default behaviour is to reurn true if the time periods of the data load have changed, false otherwise.
protected int	removeOldUnitsS(long mastrClockSample)
protected int	removeOldUnitsT(long currentTimeMS)	Removes olderPamDataUnits from memory, starting at the first unit and continuing until if finds one with data coming earlier than the given time in milliseconds.
boolean	saveViewerData()	Saves data in this data block in offline viewer mode.
void	updatePamData(DetectionGroupDataUnit pamDataUnit, long updateTimeMillis)	update a dataunit.

Methods inherited from class PamguardMVC.superdet.SuperDetDataBlock

clearOnViewerLoad, dummyClassResolve, findSubDetDataBlock, getLogging, getSubDetectionClass, getSubtableData, getViewerLoadPolicy, makeSubDetectionInfo, reattachAllSubDetections, reattachSubdetections, setSubtableData, setViewerLoadPolicy

Methods inherited from class PamguardMVC.PamDataBlock

addDataAnnotationType, addLocalisationContents, addObserver, addObserver, addOfflineDataMap, addOldPamData, autoEffortProvider, autoSetDataBlockMixMode, cancelDataOrder, cancelDataOrder, checkOfflineDataUIDs, clearAll, clearChannelIterators, clearDeletedList, copyDataList, createProcessAnnotations, createProcessAnnotations, dispose, dumpBlockContents, dumpBufferStatus, findAnnotation, findAnnotation, findByDatabaseIndex, findDataUnit, findDataUnit, findFirstUnitAfter, findLastUnitBefore, findUnitByUIDandUTC, findUnitsinInterval, getAbsoluteDataUnit, getAnnotationHandler, getARealChannel, getBackgroundManager, getBespokeDataMapGraphic, getBinaryDataSource, getCanLog, getChannelIterator, getChannelIteratorCount, getChannelMap, getChannelsForSequenceMap, getClosestUnitMillis, getClosestUnitMillis, getClosestUnitMillisUsingSeq, getCrossReferenceInformation, getCumulativeGain, getCurrentViewDataEnd, getCurrentViewDataStart, getDataAutomationInfo, getDataBlockXML, getDataCopy, getDataCopy, getDataCopy, getDataCopy, getDataCopyFromEnd, getDataCopyFromStart, getDataGain, getDatagrammedMap, getDatagramProvider, getDataName, getDataSelectCreator, getDataSelector, getDataSelector, getDataSelector, getDataUnit, getDataUnitMenuItems, getDataUnitPopupMenu, getDurationRange, getEffortProvider, getFirstRawSourceDataBlock, getFirstUnit, getFirstUnit, getFirstUnitAfter, getFirstViewerUID, getFrequencyRange, getHydrophoneMap, getJSONDataSource, getLastUnit, getLastUnit, getLastUnitMillis, getLastViewerUID, getListIterator, getListIterator, getListIteratorFromEnd, getListIteratorFromStart, getLocalisationAlgorithm, getLocalisationContents, getLoggingName, getLongDataName, getMixedDirection, getMyDataUnits, getNanoTimeCalculator, getNaturalLifetime, getNaturalLifetimeMillis, getNextDataStart, getNextUnit, getNextUnit, getNumOfflineDataMaps, getNumRequiredBeforeLoadTime, getOfflineData, getOfflineDataMap, getOfflineDataMap, getPamConfiguration, getPamSymbolManager, getParentProcess, getPreceedingUnit, getPreceedingUnit, getPreceedingUnit, getPreceedingUnit, getPreceedingUnitFromSeq, getPreceedingUnitFromSeq, getPrevDataEnd, getPrimaryDataMap, getProcessAnnotations, getQuickId, getQuickId2, getRawSourceDataBlock, getRawSourceDataBlock2, getRecordingTrigger, getRecycledUnit, getRecyclingStoreLength, getRemovedItems, getReverseChannelIterator, getSampleRate, getSaveRequirements, getSequenceCount, getSequenceIterator, getSequenceMap, getSequenceMapObject, getShouldBinary, getShouldLog, getShouldLog, getSourceDataBlock, getSourceProcess, getSuperDetectionClass, getSynchLock, getTaskDataCopy, getTOADCalculator, getUidHandler, getUIDRepairLogging, getUniqueParentList, getUnitClass, getUnitIndex, getUnitsCount, getUnitsCountFromTime, hasDataRange, isCanClipGenerate, isClearAtStart, isLinkGpsData, isOffline, isRecycling, loadViewerData, loadViewerData, masterClockUpdate, noteNewSettings, notifyModelChanged, notifyOfflineObservers, orderOfflineData, orderOfflineData, orderOfflineData, pamStart, pamStop, remove, remove, remove, removedDataUnit, removeOfflineDataMap, reset, setAnnotationHandler, setBackgroundManager, setBinaryDataSource, setCanClipGenerate, setChannelMap, setClearAtStart, setCurrentViewDataEnd, setCurrentViewDataStart, setDatagramProvider, setDataName, setDataSelectCreator, setEffortProvider, setJSONDataSource, setLinkGpsData, setLocalisationContents, SetLogging, setMixedDirection, setNanoTimeCalculator, setNaturalLifetime, setNaturalLifetimeMillis, setPamSymbolManager, setParentProcess, setRecordingTrigger, setRecycling, setRecyclingStoreLength, setSampleRate, setSequenceMap, setShouldBinary, setShouldLog, setSynchLock, setUidHandler, shouldNotify, sortData, sortOutputMaps, stopTimer, toString

Methods inherited from class PamguardMVC.PamObservable

addInstantObserver, canDraw, canDraw, clearchanged, countObservers, createKeyItem, deleteObserver, deleteObservers, drawDataUnit, findThreadedObserver, getCPUPercent, getCPUPercent, getHoverText, getInstantObservers, getLongestObserver, getMaxThreadJitter, getOverlayDraw, getPamObserver, getPamObservers, getRequiredHistory, isInstantObserver, notifyInstantObservers, notifyNornalObservers, notifyObservers, notifyObservers, setChanged, setOverlayDraw, updateObservers, waitForThreadedObservers

Methods inherited from class java.lang.Object

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

Constructor Details

DetectionGroupDataBlock

public DetectionGroupDataBlock(String dataName,
 DetectionGroupControl detectionGroupControl,
 DetectionGroupProcess detectionGroupProcess)

Method Details

saveViewerData

public boolean saveViewerData()

Description copied from class: PamDataBlock

Saves data in this data block in offline viewer mode.

Overrides:

saveViewerData in class PamDataBlock<DetectionGroupDataUnit>

Returns:

true if data found and saved.

addPamData

public void addPamData(DetectionGroupDataUnit pamDataUnit)

Description copied from class: PamDataBlock

Adds a new PamDataUnit to the PamDataBlock. When the data unit is added, PamObservers that have subscribed to the block will be notified.
If the data unit already has a UID, it will be left as is.

Overrides:

addPamData in class PamDataBlock<DetectionGroupDataUnit>

Parameters:

pamDataUnit - Reference to a PamDataUnit

addPamData

public void addPamData(DetectionGroupDataUnit pamDataUnit,
 Long uid)

Description copied from class: PamDataBlock

Adds a new PamDataUnit to the PamDataBlock and force the UID to a specific value. This should only be used in very specific circumstances - nromally, programmers should call addPamData(Tunit pamDataUnit) and let PAMGuard handle the UID's.

Overrides:

addPamData in class PamDataBlock<DetectionGroupDataUnit>

Parameters:

pamDataUnit - Reference to a PamDataUnit

uid - Unique identifier for data unit.

updatePamData

public void updatePamData(DetectionGroupDataUnit pamDataUnit,
 long updateTimeMillis)

Description copied from class: PamDataBlock

update a dataunit. Does little except flag that the data unit is updated (so it will get saved), and sends notifications to other modules.

Overrides:

updatePamData in class PamDataBlock<DetectionGroupDataUnit>

Parameters:

pamDataUnit -

updateTimeMillis -

removeOldUnitsT

protected int removeOldUnitsT(long currentTimeMS)

Description copied from class: PamDataBlock

Removes olderPamDataUnits from memory, starting at the first unit and continuing until if finds one with data coming earlier than the given time in milliseconds.

If the data are acoustic, it tries to find the data source and looks to see how much data has been placed in the source data unit and does the calculation in samples.

Overrides:

removeOldUnitsT in class PamDataBlock<DetectionGroupDataUnit>

Parameters:

currentTimeMS - Time in milliseconds of the first data which must be kept

Returns:

the number of units removed

removeOldUnitsS

protected int removeOldUnitsS(long mastrClockSample)

Overrides:

removeOldUnitsS in class PamDataBlock<DetectionGroupDataUnit>

needViewerDataLoad

public boolean needViewerDataLoad(OfflineDataLoadInfo offlineDataLoadInfo)

Description copied from class: PamDataBlock

Do we need to reload offline data ? Default behaviour is to reurn true if the time periods of the data load have changed, false otherwise.

Overrides:

needViewerDataLoad in class PamDataBlock<DetectionGroupDataUnit>

Parameters:

offlineDataLoadInfo -

Returns:

true if we need to reload offline data.

clearAll

public void clearAll()

Description copied from class: PamDataBlock

Clears all PamDataUnits from memory

In viewer mode, data are also re-saved.

Overrides:

clearAll in class PamDataBlock<DetectionGroupDataUnit>

canSuperDetection

public boolean canSuperDetection(PamDataBlock subDataBlock)

Description copied from class: SuperDetDataBlock

Return whether this type of super detection can hold the passed sub detection data. Default is based on class compatibility, but some super det datablocks should override this if they only manage one stream of data.

Overrides:

canSuperDetection in class SuperDetDataBlock<DetectionGroupDataUnit,PamDataUnit>

Parameters:

subDataBlock - Sub detection data block

Returns:

true if this data can hold those sub data.

getTethysDataProvider

public TethysDataProvider getTethysDataProvider(TethysControl tethysControl)

Description copied from class: PamDataBlock

Gets a data provider for Tethys. These will probably need to be bespoke, but for now will autogenerate based on the SQLLogging information.

Overrides:

getTethysDataProvider in class PamDataBlock<DetectionGroupDataUnit>

Returns:

the tethysDataProvider

getDatablockSpeciesManager

public DataBlockSpeciesManager<DetectionGroupDataUnit> getDatablockSpeciesManager()

Description copied from class: PamDataBlock

Get information about species types that may occur within this data block. Primarily for conversion into Tethys compatible data, but may prove to have other uses.

Overrides:

getDatablockSpeciesManager in class PamDataBlock<DetectionGroupDataUnit>

Returns:

Types of species information available within this datablock.