Package effortmonitor

Class EffortDataUnit

java.lang.Object

PamguardMVC.PamDataUnit

effortmonitor.EffortDataUnit

All Implemented Interfaces:

Comparable

public class EffortDataUnit
extends PamDataUnit

Constructor Summary

Constructors

Constructor	Description
EffortDataUnit(int databaseIndex, AbstractPamScroller scroller, String displayName, long timeMilliseconds, long endTime, String observer, String objective, long sessStart, long sessEnd, String runMode)	Constructor to use when reloading from database.
EffortDataUnit(AbstractPamScroller scroller, String observer, String objective)	Constructor for new scroll effort data

Method Summary

Modifier and Type	Method	Description
boolean	extendRecordedRange()	Extend the recorded range of this scroller.
String	getDisplayName()	Get the scroller (display) name
String	getObjective()
String	getObserver()
String	getRunMode()
AbstractPamScroller	getScroller()
long	getSessionEndTime()	The time the observer did the actual viewing, i.e.
long	getSessionStartTime()	The time the observer did the actual viewing, i.e.
String	getSummaryString()	Return an html formatted summary string describing the detection which can be used in tooltips anywhere in PAMGuard.
boolean	isActive()	Is the data active, i.e.
boolean	isContinuous()	Say if the current scroll position is continuous with the existing recorded time or if there is a gap of any sort.
void	setActive(boolean isActive)	Set to false once there has been a gap in scrolling and this data unit is closed but held in memory.
void	setObjective(String objective)
void	setObserver(String observer)
void	setOuterLimits()	Set the limits as the outer limits of the scroller.

Methods inherited from class PamguardMVC.PamDataUnit

addDataAnnotation, addSuperDetection, amplifyMeasuredAmplitudeByDB, amplifyMeasuredAmplitudeByLinear, calcSnapshotGeometry, clearOandAngles, clearUpdateCount, compareTo, 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, 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, toString, wait, wait, wait

Constructor Details

EffortDataUnit

public EffortDataUnit(AbstractPamScroller scroller,
 String observer,
 String objective)

Constructor for new scroll effort data

Parameters:

scroller -

observer -

objective -

EffortDataUnit

public EffortDataUnit(int databaseIndex,
 AbstractPamScroller scroller,
 String displayName,
 long timeMilliseconds,
 long endTime,
 String observer,
 String objective,
 long sessStart,
 long sessEnd,
 String runMode)

Constructor to use when reloading from database.

Parameters:

databaseIndex -

scroller -

displayName -

timeMilliseconds -

endTime -

observer -

objective -

sessStart -

sessEnd -

Method Details

isContinuous

public boolean isContinuous()

Say if the current scroll position is continuous with the existing recorded time or if there is a gap of any sort.

Returns:

true if no gap or an overlap, false if a gap

extendRecordedRange

public boolean extendRecordedRange()

Extend the recorded range of this scroller.

Returns:

true if the range has changed

getScroller

public AbstractPamScroller getScroller()

Returns:

the scroller

getObserver

public String getObserver()

Returns:

the observer

isActive

public boolean isActive()

Is the data active, i.e. is being scrolled and no gaps have been made in the data

Returns:

the isActive

setActive

public void setActive(boolean isActive)

Set to false once there has been a gap in scrolling and this data unit is closed but held in memory. There should only be one active unit for each scroller.

Parameters:

isActive - the isActive to set

getSessionStartTime

public long getSessionStartTime()

The time the observer did the actual viewing, i.e. the System.currenttime()

Returns:

the startTime

getSessionEndTime

public long getSessionEndTime()

The time the observer did the actual viewing, i.e. the System.currenttime()

Returns:

the endTime

getDisplayName

public String getDisplayName()

Get the scroller (display) name

Returns:

display name

getObjective

public String getObjective()

Returns:

the objective

setObjective

public void setObjective(String objective)

Parameters:

objective - the objective to set

setObserver

public void setObserver(String observer)

Parameters:

observer - the observer to set

getSummaryString

public String getSummaryString()

Description copied from class: PamDataUnit

Return an html formatted summary string describing the detection which can be used in tooltips anywhere in PAMGuard.

Overrides:

getSummaryString in class PamDataUnit

Returns:

summary string

getRunMode

public String getRunMode()

Returns:

the runMode

setOuterLimits

public void setOuterLimits()

Set the limits as the outer limits of the scroller.