PamDataUnit

java.lang.Object
- PamguardMVC.PamDataUnit

All Implemented Interfaces:

java.lang.Comparable<PamDataUnit>

Direct Known Subclasses:

AcousticDataUnit, AISDataUnit, AlarmDataUnit, AngleDataUnit, ArrayAccelDataUnit, AutecDataUnit, BeakedDataUnit, BeakedExperimentData, BuoyStatusDataUnit, D3DataUnit, DaqStatusDataUnit, DepthDataUnit, DStrDataUnit, DummyClick, EchoDataUnit, FormsDataUnit, GpsDataUnit, HydrophoneDataUnit, IshmaelDataUnit, LandmarkDataUnit, ListeningEffortData, MapComment, NMEADataUnit, PamImage, RecorderDataUnit, RoccaLoggingDataUnit, SerialDataUnit, ShoreStationDataUnit, SimObjectDataUnit, SimSoundDataUnit, SLResult, SMLStatusDataUnit, StreamerDataUnit, TargetMotionResult, ThingHeard, TideDataUnit, UserInputDataUnit, VRDataUnit
```
public abstract class PamDataUnit
extends java.lang.Object
implements java.lang.Comparable<PamDataUnit>
```
Author:

Doug Gillespie
Class for units of PAM data.
PamDataUnit's are held in ArrayLists within PamDataBlocks.
When a PamDataUnit is added to a PamDataBlock any PamProcesses that subscribe to that PamDataBlock receive a notification and can retrieve the PamDataUnits from the block.
Any data derived from acoustic data should subclass from AcousticDataUnit

See Also:
PamDataBlock, AcousticDataUnit

Constructor Summary

Constructors
Constructor and Description

PamDataUnit(long timeMilliseconds)

Constructors
Constructor and Description
`PamDataUnit(long timeMilliseconds)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addDataAnnotation(DataAnnotation dataAnnotation)` Adds a data annotation to the data unit.
`void`	`clearOandAngles()`
`void`	`clearUpdateCount()` Do a clear of update count after a database save.
`int`	`compareTo(PamDataUnit o)`
`DataAnnotation`	`findDataAnnotation(java.lang.Class annotationClass)` Find a data annotation that can cast to a certain type.
`int`	`getAbsBlockIndex()`
`int`	`getChannelBitmap()`
`DataAnnotation`	`getDataAnnotation(int index)` Get a data annotation.
`int`	`getDatabaseIndex()`
`int`	`getDatabaseUpdateOf()`
`DataUnitFileInformation`	`getDataUnitFileInformation()`
`AbstractDetectionMatch`	`getDetectionMatch()`
`AbstractDetectionMatch`	`getDetectionMatch(int type)`
`double`	`getHydrophoneHeading(boolean recalculate)` Get the hydrophone heading for the first hydrophone included in the detection.
`long`	`getLastUpdateTime()`
`AbstractLocalisation`	`getLocalisation()`
`int`	`getNumDataAnnotations()`
`GpsData`	`getOriginLatLong(boolean recalculate)` Get the latlong of the mean hydrophone position at the time of this detection.
`double`	`getPairAngle(int pair, boolean recalculate)` Return the angle between pairs of hydrophones.
`PamDataBlock`	`getParentDataBlock()`
`java.lang.String`	`getSummaryString()` Return an html formatted summary string describing the detection which can be used in tooltips anywhere in PAMGuard.
`long`	`getTimeMilliseconds()`
`int`	`getUpdateCount()`
`boolean`	`removeDataAnnotation(DataAnnotation annotation)` Remove a data annotation
`DataAnnotation`	`removeDataAnnotation(int index)` Remove a data annotation
`void`	`setAbsBlockIndex(int absBlockIndex)`
`void`	`setChannelBitmap(int channelBitmap)`
`void`	`setDatabaseIndex(int databaseIndex)`
`void`	`setDatabaseUpdateOf(int databaseUpdateOf)`
`void`	`setDataUnitFileInformation(DataUnitFileInformation dataUnitFileInformation)`
`void`	`setLastUpdateTime(long lastUpdateTime)`
`void`	`setLocalisation(AbstractLocalisation localisation)`
`void`	`setOriginLatLong(GpsData oll)`
`void`	`setParentDataBlock(PamDataBlock parentDataBlock)`
`void`	`setTimeMilliseconds(long timeMilliseconds)`
`void`	`updateDataUnit(long updateTime)`

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - PamDataUnit
```
public PamDataUnit(long timeMilliseconds)
```
- Method Detail
  - setAbsBlockIndex
```
public void setAbsBlockIndex(int absBlockIndex)
```
  - setParentDataBlock
```
public void setParentDataBlock(PamDataBlock parentDataBlock)
```
  - setTimeMilliseconds
```
public void setTimeMilliseconds(long timeMilliseconds)
```
  - getAbsBlockIndex
```
public int getAbsBlockIndex()
```
  - getParentDataBlock
```
public PamDataBlock getParentDataBlock()
```
  - getTimeMilliseconds
```
public long getTimeMilliseconds()
```
  - updateDataUnit
```
public void updateDataUnit(long updateTime)
```
  - clearUpdateCount
```
public void clearUpdateCount()
```
    Do a clear of update count after a database save.
  - getUpdateCount
```
public int getUpdateCount()
```
    Returns:
    the number of times the data unit has been updated.
  - getChannelBitmap
```
public int getChannelBitmap()
```
  - setChannelBitmap
```
public void setChannelBitmap(int channelBitmap)
```
  - getOriginLatLong
```
public GpsData getOriginLatLong(boolean recalculate)
```
    Get the latlong of the mean hydrophone position at the time of this detection.
    
    Parameters:
    recalculate -
    
    Returns:
    Lat long of detection origin (usually the position of the reference hydrophone at time of detection)
  - setOriginLatLong
```
public void setOriginLatLong(GpsData oll)
```
  - getPairAngle
```
public double getPairAngle(int pair,
                  boolean recalculate)
```
    Return the angle between pairs of hydrophones. For a n channel detection, n-1 pair angles are calculated, each being the bearing, realtive to north, from the pair+1th hydrophone TO the 0th hydrophone (i.e. for a 2 channel array, there is one pair calculated and it's from channel 1 to channel 0, which is the most useful. If other inter-pair angles are required, then it should easy to calculate them from these values.
    
    Parameters:
    pair -
    recalculate -
    
    Returns:
    angle clockwise from North in degrees.
  - getHydrophoneHeading
```
public double getHydrophoneHeading(boolean recalculate)
```
    Get the hydrophone heading for the first hydrophone included in the detection.
    
    Parameters:
    reacalculate - force recalculation
    
    Returns:
    hydrophone heading
  - clearOandAngles
```
public void clearOandAngles()
```
  - getLastUpdateTime
```
public long getLastUpdateTime()
```
  - setLastUpdateTime
```
public void setLastUpdateTime(long lastUpdateTime)
```
  - getDatabaseIndex
```
public int getDatabaseIndex()
```
  - setDatabaseIndex
```
public void setDatabaseIndex(int databaseIndex)
```
  - getDatabaseUpdateOf
```
public int getDatabaseUpdateOf()
```
  - setDatabaseUpdateOf
```
public void setDatabaseUpdateOf(int databaseUpdateOf)
```
  - getDataUnitFileInformation
```
public DataUnitFileInformation getDataUnitFileInformation()
```
  - setDataUnitFileInformation
```
public void setDataUnitFileInformation(DataUnitFileInformation dataUnitFileInformation)
```
  - compareTo
```
public int compareTo(PamDataUnit o)
```
    Specified by:
    
    compareTo in interface java.lang.Comparable<PamDataUnit>
  - getLocalisation
```
public AbstractLocalisation getLocalisation()
```
    Returns:
    Returns the localisation.
  - getDetectionMatch
```
public AbstractDetectionMatch getDetectionMatch()
```
    Returns:
    Returns the large aperture localisation.
  - getDetectionMatch
```
public AbstractDetectionMatch getDetectionMatch(int type)
```
    Returns:
    Returns the large aperture localisation.
  - setLocalisation
```
public void setLocalisation(AbstractLocalisation localisation)
```
    Parameters:
    localisation - The localisation to set.
  - getSummaryString
```
public java.lang.String getSummaryString()
```
    Return an html formatted summary string describing the detection which can be used in tooltips anywhere in PAMGuard.
    
    Returns:
    summary string
  - addDataAnnotation
```
public void addDataAnnotation(DataAnnotation dataAnnotation)
```
    Adds a data annotation to the data unit.
    
    Parameters:
    dataAnnotation - data annotation
  - getNumDataAnnotations
```
public int getNumDataAnnotations()
```
    Returns:
    the number of data annotations
  - getDataAnnotation
```
public DataAnnotation getDataAnnotation(int index)
```
    Get a data annotation.
    No array size checking so call getNumDataAnnotations first !
    
    Parameters:
    index - index of data annotation
    
    Returns:
    a data annotation.
  - findDataAnnotation
```
public DataAnnotation findDataAnnotation(java.lang.Class annotationClass)
```
    Find a data annotation that can cast to a certain type.
    
    Parameters:
    annotationClass - class to search for
    
    Returns:
    data annotation or null
  - removeDataAnnotation
```
public DataAnnotation removeDataAnnotation(int index)
```
    Remove a data annotation
    
    Parameters:
    index - index of data annotation
    
    Returns:
    Reference to data annotation or null if it wasn't in the list
  - removeDataAnnotation
```
public boolean removeDataAnnotation(DataAnnotation annotation)
```
    Remove a data annotation
    
    Parameters:
    annotation - reference to data annotation to remove.
    
    Returns:
    true if the annotation was included in the list.

Class PamDataUnit

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PamDataUnit

Method Detail

setAbsBlockIndex

setParentDataBlock

setTimeMilliseconds

getAbsBlockIndex

getParentDataBlock

getTimeMilliseconds

updateDataUnit

clearUpdateCount

getUpdateCount

getChannelBitmap

setChannelBitmap

getOriginLatLong

setOriginLatLong

getPairAngle

getHydrophoneHeading

clearOandAngles

getLastUpdateTime

setLastUpdateTime

getDatabaseIndex

setDatabaseIndex

getDatabaseUpdateOf

setDatabaseUpdateOf

getDataUnitFileInformation

setDataUnitFileInformation

compareTo

getLocalisation

getDetectionMatch

getDetectionMatch

setLocalisation

getSummaryString

addDataAnnotation

getNumDataAnnotations

getDataAnnotation

findDataAnnotation

removeDataAnnotation

removeDataAnnotation