Package clipgenerator

Class ClipDataBlock

java.lang.Object

PamguardMVC.PamObservable

PamguardMVC.PamDataBlock<ClipDataUnit>

PamguardMVC.AcousticDataBlock<ClipDataUnit>

clipgenerator.ClipDisplayDataBlock<ClipDataUnit>

clipgenerator.ClipDataBlock

All Implemented Interfaces:

OrganisedFFTData

public class ClipDataBlock
extends ClipDisplayDataBlock<ClipDataUnit>
implements OrganisedFFTData

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
ClipDataBlock(String dataName, ClipProcess clipProcess, int channelMap)

Method Summary

Modifier and Type	Method	Description
DataSelectorCreator	getDataSelectCreator()
DataSelector	getDataSelector(String selectorName, boolean allowScores, String selectorType)	Convenience method to save programmer from having to call into the creator all the time.
List<JMenuItem>	getDataUnitMenuItems(DataMenuParent menuParent, Point mousePosition, PamDataUnit... dataUnits)	Get menu items pertinent to one or more data units.
FFTDataOrganiser	getFFTDataOrganiser()
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.

Methods inherited from class PamguardMVC.AcousticDataBlock

findParentSource, getChannelListManager, getDataBlockXML, getParentSourceData, notifyModelChanged, prepareAmplitudeCalculations, prepareChannelLists

Methods inherited from class PamguardMVC.PamDataBlock

addDataAnnotationType, addLocalisationContents, addObserver, addObserver, addOfflineDataMap, addOldPamData, addPamData, addPamData, autoEffortProvider, autoSetDataBlockMixMode, cancelDataOrder, cancelDataOrder, checkOfflineDataUIDs, clearAll, clearAll, clearChannelIterators, clearDeletedList, clearOnViewerLoad, 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, getDatablockSpeciesManager, getDataCopy, getDataCopy, getDataCopy, getDataCopy, getDataCopyFromEnd, getDataCopyFromStart, getDataGain, getDatagrammedMap, getDatagramProvider, getDataName, getDataSelector, getDataSelector, getDataUnit, getDataUnitPopupMenu, getDurationRange, getEffortProvider, getFirstRawSourceDataBlock, getFirstUnit, getFirstUnit, getFirstUnitAfter, getFirstViewerUID, getFrequencyRange, getHydrophoneMap, getJSONDataSource, getLastUnit, getLastUnit, getLastUnitMillis, getLastViewerUID, getListIterator, getListIterator, getListIteratorFromEnd, getListIteratorFromStart, getLocalisationAlgorithm, getLocalisationContents, getLogging, 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, getTethysDataProvider, getTOADCalculator, getUidHandler, getUIDRepairLogging, getUniqueParentList, getUnitClass, getUnitIndex, getUnitsCount, getUnitsCountFromTime, hasDataRange, isCanClipGenerate, isClearAtStart, isLinkGpsData, isOffline, isRecycling, loadViewerData, loadViewerData, masterClockUpdate, needViewerDataLoad, noteNewSettings, notifyOfflineObservers, orderOfflineData, orderOfflineData, orderOfflineData, pamStart, pamStop, remove, remove, remove, removedDataUnit, removeOfflineDataMap, reset, saveViewerData, 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, updatePamData

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

ClipDataBlock

public ClipDataBlock(String dataName,
 ClipProcess clipProcess,
 int channelMap)

Method Details

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<ClipDataUnit>

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<ClipDataUnit>

getDataUnitMenuItems

public List<JMenuItem> getDataUnitMenuItems(DataMenuParent menuParent,
 Point mousePosition,
 PamDataUnit... dataUnits)

Description copied from class: PamDataBlock

Get menu items pertinent to one or more data units.

Note that if multiple units have been selected on some of the generic displays, it's possible that they may not all be of the same types so may not all belong to this datablock.

If it's only a single unit, then its guaranteed that it will be from this datablock.

Overrides:

getDataUnitMenuItems in class PamDataBlock<ClipDataUnit>

Parameters:

menuParent - information about the display requesting these items.

dataUnits - List of one or more selected data units.

Returns:

null or one or more menu items.

getDataSelectCreator

public DataSelectorCreator getDataSelectCreator()

Overrides:

getDataSelectCreator in class PamDataBlock<ClipDataUnit>

Returns:

an object that can create data selectors to sub select data from within this type of data block.

getDataSelector

public DataSelector getDataSelector(String selectorName,
 boolean allowScores,
 String selectorType)

Description copied from class: PamDataBlock

Convenience method to save programmer from having to call into the creator all the time.

Overrides:

getDataSelector in class PamDataBlock<ClipDataUnit>

Parameters:

selectorName -

allowScores -

selectorType - Type of selector, generally a ModuleType name, e.g. Map, so that options can be tailored to specific needs

Returns:

null or a DataSelector

getFFTDataOrganiser

public FFTDataOrganiser getFFTDataOrganiser()

Specified by:

getFFTDataOrganiser in interface OrganisedFFTData