Package Array

Class StreamerDataUnit

java.lang.Object

PamguardMVC.PamDataUnit

Array.StreamerDataUnit

All Implemented Interfaces:

Comparable

public class StreamerDataUnit
extends PamDataUnit

Constructor Summary

Constructors

Constructor	Description
StreamerDataUnit(long timeMilliseconds, Streamer streamer)

Method Summary

Modifier and Type	Method	Description
static StreamerDataUnit	getAverage(StreamerDataUnit sd1, StreamerDataUnit sd2)	Average two streamer data units.
GpsData	getGpsData()	We need to get the GPS unit associated with this array, however, we only wish to add roll, pitch and heading to that unit if we have enabled the use of orientation data.
Streamer	getStreamerData()
StreamerDataUnit	makeCombinedGpsUnit(GpsDataUnit gpsDataUnit)	Make a combined streamer data unit that has both the streamer data and GPS data so that localisers have easy access to both types of information.
void	setGpsData(GpsData gpsData)
void	setStreamerData(Streamer streamerData)

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, 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, toString, wait, wait, wait

Constructor Details

StreamerDataUnit

public StreamerDataUnit(long timeMilliseconds,
 Streamer streamer)

Method Details

getStreamerData

public Streamer getStreamerData()

Returns:

the streamerData

setStreamerData

public void setStreamerData(Streamer streamerData)

Parameters:

streamerData - the streamerData to set

getAverage

public static StreamerDataUnit getAverage(StreamerDataUnit sd1,
 StreamerDataUnit sd2)

Average two streamer data units.

Parameters:

sd1 -

sd2 -

Returns:

makeCombinedGpsUnit

public StreamerDataUnit makeCombinedGpsUnit(GpsDataUnit gpsDataUnit)

Make a combined streamer data unit that has both the streamer data and GPS data so that localisers have easy access to both types of information.

Parameters:

gpsDataUnit -

Returns:

a new combined streamer data unit.

setGpsData

public void setGpsData(GpsData gpsData)

getGpsData

public GpsData getGpsData()

We need to get the GPS unit associated with this array, however, we only wish to add roll, pitch and heading to that unit if we have enabled the use of orientation data. Thus we must clone() the realGps data unit so we don't inadvertently overwrite true heading data or even pitch and roll data which has been saved with the GPS data unit.

Returns:

cloned gps data unit with the heading, pitch and roll added if orientation is anabled for this streamer data unit.