Package effort

Class EffortDataUnit

java.lang.Object

PamguardMVC.PamDataUnit

effort.EffortDataUnit

All Implemented Interfaces:

Comparable

Direct Known Subclasses:

DataMapEffortThing, FormsEffortUnit

public class EffortDataUnit
extends PamDataUnit

Field Summary

Fields

Modifier and Type	Field	Description
static final long	ONGOINGEFFORT	Value for effort end to say that effort is ongoing.

Constructor Summary

Constructors

Constructor	Description
EffortDataUnit(EffortProvider effortProvider, PamDataUnit referenceDataUnit, long effortStart, long effortEnd)

Method Summary

Modifier and Type	Method	Description
int	compareTo(PamDataUnit o)
String	getEffortDescription()	Description of the effort, for tool tips, etc.
long	getEffortEnd()
long	getEffortStart()
PamDataUnit	getReferenceDataUnit()
boolean	inEffort(long timeMilliseconds)
void	setEffortEnd(long endTime)	Set the effort end time
void	setReferenceDataUnit(PamDataUnit referenceDataUnit)
String	toString()

Methods inherited from class PamguardMVC.PamDataUnit

addDataAnnotation, addSuperDetection, amplifyMeasuredAmplitudeByDB, amplifyMeasuredAmplitudeByLinear, calcSnapshotGeometry, clearOandAngles, clearUpdateCount, findDataAnnotation, findDataAnnotation, freeData, getAbsBlockIndex, getAmplitudeDB, getAnnotationsSummaryString, getBasicData, getCalculatedAmlitudeDB, getChannelBitmap, getColourIndex, getDataAnnotation, getDatabaseIndex, getDatabaseUpdateOf, getDataUnitFileInformation, getDataUnitPopupMenu, getDurationInMilliseconds, getEndTimeInMilliseconds, getFrequency, getFrequencyOverlap, getHydrophoneBitmap, getHydrophoneHeading, getLastChangeTime, getLastSample, getLastUpdateTime, getLocalisation, getMeasuredAmplitude, getMeasuredAmplitudeType, getNoiseBackground, getNumDataAnnotations, getOriginLatLong, getParentDataBlock, getSampleDuration, getSampleDurationAsInt, getSeconds, getSequenceBitmap, getSequenceBitmapObject, getSignalExcess, getSignalSPL, getSnapshotGeometry, getStartSample, getSummaryString, getSuperDetection, getSuperDetection, getSuperDetection, getSuperDetection, getSuperDetection, getSuperDetectionsCount, getSuperDetectionSyncronisation, getSuperId, getTimeDelaysSeconds, getTimeMilliseconds, getTimeNanoseconds, getTimeOverlap, getUID, getUpdateCount, isEmbryonic, isForceAmpRecalc, linAmplitudeToDB, removeDataAnnotation, removeDataAnnotation, removeSuperDetection, setAbsBlockIndex, setCalculatedAmlitudeDB, setChannelBitmap, setDatabaseIndex, setDatabaseUpdateOf, setDataUnitFileInformation, setDurationInMilliseconds, setEmbryonic, setForceAmpRecalc, setFrequency, setInfo, setLastUpdateTime, setLocalisation, setMeasuredAmpAndType, setMeasuredAmplitude, setMeasuredAmplitudeType, setNoiseBackground, setParentDataBlock, setSampleDuration, setSequenceBitmap, setSignalExcess, setSignalSPL, setSnapshotGeometry, setStartSample, setTimeDelaysSeconds, setTimeMilliseconds, setUID, setUniqueSuperDetection, sortOutputMaps, updateDataUnit

Methods inherited from class java.lang.Object

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

Field Details

ONGOINGEFFORT

public static final long ONGOINGEFFORT

Value for effort end to say that effort is ongoing.

See Also:

• Constant Field Values

Constructor Details

EffortDataUnit

public EffortDataUnit(EffortProvider effortProvider,
 PamDataUnit referenceDataUnit,
 long effortStart,
 long effortEnd)

Method Details

getEffortStart

public long getEffortStart()

Returns:

Start of effort period.

getEffortEnd

public long getEffortEnd()

Returns:

End of effort period.

setEffortEnd

public void setEffortEnd(long endTime)

Set the effort end time

Parameters:

endTime -

inEffort

public boolean inEffort(long timeMilliseconds)

Parameters:

timeMilliseconds -

Returns:

time is in effort period

getEffortDescription

public String getEffortDescription()

Description of the effort, for tool tips, etc.

Returns:

getReferenceDataUnit

public PamDataUnit getReferenceDataUnit()

Returns:

the referenceDataUnit

setReferenceDataUnit

public void setReferenceDataUnit(PamDataUnit referenceDataUnit)

Parameters:

referenceDataUnit - the referenceDataUnit to set

toString

public String toString()

Overrides:

toString in class Object

compareTo

public int compareTo(PamDataUnit o)

Overrides:

compareTo in class PamDataUnit