Package loggerForms

Class FormsDataUnit

java.lang.Object

PamguardMVC.PamDataUnit

loggerForms.FormsDataUnit

All Implemented Interfaces:

Comparable

public class FormsDataUnit
extends PamDataUnit

Author:

Graham Weatherup ID UTC UTCmillisecond PCLocalTime

Field Summary

Fields

Modifier and Type	Field	Description
static final int	currentXMLFormat

Fields inherited from class PamguardMVC.PamDataUnit

absBlockIndex, localisation

Constructor Summary

Constructors

Constructor	Description
FormsDataUnit(LoggerForm loggerForm, long timeMilliseconds, FormDescription formDescription, Object[] formData)	Constructor for a form data unit.

Method Summary

Modifier and Type	Method	Description
Long	findTimeValue(PropertyTypes timeProperty)	Find one of the time property controls and get its value.
long	getEndTimeInMilliseconds()
Object[]	getFormData()	This formData Array is based around the inputControlDescriptions ArrayList in formDescriptions.
FormDescription	getFormDescription()
LoggerForm	getLoggerForm()
GpsData	getOriginLatLong(boolean recalculate)	Get the latlong of the mean hydrophone position at the time of this detection.
Long	getSetEndTime()	find a correctly set property value for the end time (if set).
String	getSummaryString()	Return an html formatted summary string describing the detection which can be used in tooltips anywhere in PAMGuard.
long	getTimeMilliseconds()
void	setFormsData(LoggerForm loggerForm, Object[] formData)	used for updating data units(editing forms)

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, getFrequency, getFrequencyOverlap, getGpsPosition, getHydrophoneBitmap, getHydrophoneHeading, getLastChangeTime, getLastSample, getLastUpdateTime, getLocalisation, getMeasuredAmplitude, getMeasuredAmplitudeType, getNoiseBackground, getNumDataAnnotations, getParentDataBlock, getSampleDuration, getSampleDurationAsInt, getSeconds, getSequenceBitmap, getSequenceBitmapObject, getSignalExcess, getSignalSPL, getSnapshotGeometry, getStartSample, getSuperDetection, getSuperDetection, getSuperDetection, getSuperDetection, getSuperDetection, getSuperDetectionsCount, getSuperDetectionSyncronisation, getSuperId, getTimeDelaysSeconds, 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

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

Field Details

currentXMLFormat

public static final int currentXMLFormat

See Also:

• Constant Field Values

Constructor Details

FormsDataUnit

public FormsDataUnit(LoggerForm loggerForm,
 long timeMilliseconds,
 FormDescription formDescription,
 Object[] formData)

Constructor for a form data unit.

Parameters:

loggerForm -

timeMilliseconds -

formDescription -

formData -

Method Details

getFormData

public Object[] getFormData()

This formData Array is based around the inputControlDescriptions ArrayList in formDescriptions. is is of same length and order matches

Returns:

the formData

getLoggerForm

public LoggerForm getLoggerForm()

getFormDescription

public FormDescription getFormDescription()

Returns:

the formDescription

setFormsData

public void setFormsData(LoggerForm loggerForm,
 Object[] formData)

used for updating data units(editing forms)

getOriginLatLong

public GpsData getOriginLatLong(boolean recalculate)

Description copied from class: PamDataUnit

Get the latlong of the mean hydrophone position at the time of this detection. If the data unit has a channel bitmap of zero, then get the GPS position of the vessel at that time.

Overrides:

getOriginLatLong in class PamDataUnit

Parameters:

recalculate -

Returns:

Lat long of detection origin (usually the position of the reference hydrophone at time of detection)

getTimeMilliseconds

public long getTimeMilliseconds()

Overrides:

getTimeMilliseconds in class PamDataUnit

Returns:

The millisecond time of the data unit using the standard Java time system of milliseconds since midnight, January 1, 1970 UTC

findTimeValue

public Long findTimeValue(PropertyTypes timeProperty)

Find one of the time property controls and get its value.

Parameters:

timeProperty -

Returns:

getSetEndTime

public Long getSetEndTime()

find a correctly set property value for the end time (if set).

Returns:

getEndTimeInMilliseconds

public long getEndTimeInMilliseconds()

Overrides:

getEndTimeInMilliseconds in class PamDataUnit

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