Package noiseMonitor.species

Class TethysNoiseDataProvider

java.lang.Object

tethys.pamdata.AutoTethysProvider

noiseMonitor.species.TethysNoiseDataProvider

All Implemented Interfaces:

TethysDataProvider

public class TethysNoiseDataProvider
extends AutoTethysProvider

Constructor Summary

Constructors

Constructor	Description
TethysNoiseDataProvider(TethysControl tethysControl, NoiseDataBlock noiseDataBlock)

Method Summary

Modifier and Type	Method	Description
boolean	canExportLocalisations(nilus.GranularityEnumType granularityType)	See if it's possible for this block to export localisations.
nilus.Detection	createDetection(PamDataUnit dataUnit, TethysExportParams tethysExportParams, StreamExportParams streamExportParams)	Create a Tethys Detection object from a PamDataUnit. It's OK for this to return null if for some reason the unit shouldn't be stored.
nilus.GranularityEnumType[]	getAllowedGranularities()	Get a list of allowed granularity types for this output
void	getEffortKinds(PDeployment pDeployment, List<nilus.DetectionEffortKind> effortKinds, StreamExportParams exportParams)	Fill in the effort kind list for the top of a Detections document.
boolean	wantExportDialogCard(ExportWizardCard wizPanel)	See if a particular card should be used in the export wizard.

Methods inherited from class tethys.pamdata.AutoTethysProvider

addUserDefined, getAlgorithm, getAlgorithmParameters, getDescription, getDetectionsMethod, getDetectionsName, getLocalisationAlgorithm, getLocalisationInfo, getLocalisationParameters, getPamDataBlock, getTethysControl, granularityOK, hasDetections, isAddFrequencyInfo, packAnnotation, roundDecimalPlaces, roundSignificantFigures, setAddFrequencyInfo

Methods inherited from class java.lang.Object

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

Constructor Details

TethysNoiseDataProvider

public TethysNoiseDataProvider(TethysControl tethysControl,
 NoiseDataBlock noiseDataBlock)

Method Details

getAllowedGranularities

public nilus.GranularityEnumType[] getAllowedGranularities()

Description copied from interface: TethysDataProvider

Get a list of allowed granularity types for this output

Specified by:

getAllowedGranularities in interface TethysDataProvider

Overrides:

getAllowedGranularities in class AutoTethysProvider

Returns:

list of granularities.

createDetection

public nilus.Detection createDetection(PamDataUnit dataUnit,
 TethysExportParams tethysExportParams,
 StreamExportParams streamExportParams)

Description copied from interface: TethysDataProvider

Create a Tethys Detection object from a PamDataUnit.
It's OK for this to return null if for some reason the unit shouldn't be stored.

Specified by:

createDetection in interface TethysDataProvider

Overrides:

createDetection in class AutoTethysProvider

Parameters:

dataUnit - PAMGuard data unit

tethysExportParams -

streamExportParams -

Returns:

Detection Tethys Detection object.

getEffortKinds

public void getEffortKinds(PDeployment pDeployment,
 List<nilus.DetectionEffortKind> effortKinds,
 StreamExportParams exportParams)

Description copied from interface: TethysDataProvider

Fill in the effort kind list for the top of a Detections document. This must contain a list of every species that's going to be output within this effort period. Any species assigned to an actual detection must be in this list, or the document will be rejected.

Specified by:

getEffortKinds in interface TethysDataProvider

Overrides:

getEffortKinds in class AutoTethysProvider

Parameters:

pDeployment -

effortKinds - tethys object list to add to.

exportParams -

wantExportDialogCard

public boolean wantExportDialogCard(ExportWizardCard wizPanel)

Description copied from interface: TethysDataProvider

See if a particular card should be used in the export wizard. This may not be the best way of doing this, but will do for now.

Specified by:

wantExportDialogCard in interface TethysDataProvider

Overrides:

wantExportDialogCard in class AutoTethysProvider

Parameters:

wizPanel -

Returns:

canExportLocalisations

public boolean canExportLocalisations(nilus.GranularityEnumType granularityType)

Description copied from interface: TethysDataProvider

See if it's possible for this block to export localisations. This may depend on the selected granularity.

Specified by:

canExportLocalisations in interface TethysDataProvider

Overrides:

canExportLocalisations in class AutoTethysProvider

Parameters:

granularityType -

Returns: