ArrayManager

java.lang.Object
- PamController.PamControlledUnit
- - Array.ArrayManager

All Implemented Interfaces:

PamSettings, PamObserver
```
public class ArrayManager
extends PamControlledUnit
implements PamSettings, PamObserver
```
Manager for different array configurations. Each array configuration is stored in it's own serialised file, which is separate from other Pam Settings so that they can be stored, emailed around, etc. In it' main serialised file controlled by PamSettingsManager, Pamguard keeps a list of recently used arrays.
The dialog ArrayDialog allows the user to load arrays from file, create new arrays, edit arrays, etc.

Author:

Doug Gillespie

See Also:
PamArray

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ARRAY_TYPE_LINE` Line array of two or more elements
`static int`	`ARRAY_TYPE_NONE` No array specified
`static int`	`ARRAY_TYPE_PLANE` Three or more Hydrophones all in the same plane
`static int`	`ARRAY_TYPE_POINT` Point array (single phone or multiple phones at same point)
`static int`	`ARRAY_TYPE_VOLUME` Four or more hydrophones not in the same plane.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addArray(PamArray newArray)`
`void`	`fillXMLData(org.w3c.dom.Document doc, org.w3c.dom.Element xmlElement)` Write Hydrophone array data into an XML element
`int`	`getArrayCount()`
`PamVector[]`	`getArrayDirection(int phones)` Get the principle direction vectors for a sub set of hydrophones within the current array
`PamVector[]`	`getArrayDirections()` Get the principle direction vectors for the current array
`PamVector[]`	`getArrayDirections(PamArray array)` Get a set of vectors which define the principle coordinates of an array
`PamVector[]`	`getArrayDirections(PamArray array, int phones)` Get a set of vectors which define the principle components of an array.
`static java.lang.String`	`getArrayFileType()`
`static ArrayManager`	`getArrayManager()`
`int`	`getArrayShape(PamArray array)`
`int`	`getArrayShape(PamArray array, int phones)`
`int`	`getArrayType()`
`int`	`getArrayType(int phones)`
`static java.lang.String`	`getArrayTypeString(int arrayType)`
`PamVector[]`	`getArrayVectors(PamArray array, int phones)`
`PamArray`	`getCurrentArray()`
`DepthControl`	`getDepthControl()`
`static GPSDataBlock`	`getGPSDataBlock()` Gets the GPS data block, if there is one.
`HydrophoneDataBlock`	`getHydrophoneDataBlock()` Called from the network receiver to create and assign some specific hydrophone streamer within an array and to clone a streamer to make a new one if necessary
`HydrophoneSQLLogging`	`getHydrophoneSQLLogging()`
`java.lang.String`	`getObserverName()`
`PamObserver`	`getObserverObject()`
`java.util.ArrayList<PamArray>`	`getRecentArrays()`
`long`	`getRequiredDataHistory(PamObservable o, java.lang.Object arg)`
`java.io.Serializable`	`getSettingsReference()`
`long`	`getSettingsVersion()`
`int`	`getSpatiallyUniquePhones(PamArray array, int phones)` Take a list of phones and return a list of ones which are at unique positions.
`StreamerDataBlock`	`getStreamerDatabBlock()`
`java.lang.String`	`getUnitName()` Returns the name of the unit
`java.lang.String`	`getUnitType()`
`static PamArray`	`loadArrayFromFile(java.lang.String fileName)`
`void`	`masterClockUpdate(long milliSeconds, long sampleNumber)`
`void`	`noteNewSettings()`
`void`	`notifyModelChanged(int changeType)` General notification when the PAMGAURD model changes.
`boolean`	`removeArray(PamArray newArray)`
`void`	`removeObservable(PamObservable o)` called when an Observable (PamDataBlock) is removed from the system
`boolean`	`restoreSettings(PamControlledUnitSettings pamControlledUnitSettings)`
`static boolean`	`saveArrayToFile(PamArray array)`
`void`	`setCurrentArray(PamArray array)`
`void`	`setDepthControl(DepthControl depthControl)`
`void`	`setSampleRate(float sampleRate, boolean notify)` New sample rate
`void`	`showArrayDialog(java.awt.Frame parentFrame)`
`void`	`showHydrophoneImportDialog(javax.swing.JFrame guiFrame)`
`void`	`showStreamerImportDialog(javax.swing.JFrame guiFrame)`
`void`	`update(PamObservable o, PamDataUnit arg)` Informs the PamObserver that new data have been added to the Observable class

Methods inherited from class PamController.PamControlledUnit
addOfflineTaskGroup, addOtherRelatedMenuItems, addPamProcess, addRelatedMenuItems, addXMLParameter, addXMLParameter, addXMLParameter, addXMLParameter, canClose, canPlayViewerSound, createDetectionMenu, createDisplayMenu, createFileMenu, createHelpMenu, fillXMLElement, flushDataBlockBuffers, getFrameNumber, getGuiFrame, getModuleSummary, getNumOfflineTaskGroups, getNumPamProcesses, getOfflineTaskGroup, getPamController, getPamModuleInfo, getPamProcess, getPamView, getShortUnitType, getSidePanel, getTabClipCopier, getTabPanel, getTabSpecificMenuBar, getToolbarComponent, getVerboseLevel, gotoTab, isViewer, pamClose, pamHasStopped, pamToStart, playViewerSound, removePamProcess, removeUnit, rename, saveViewerData, setFrameNumber, setPamController, setPamModuleInfo, setPamView, setSidePanel, setTabPanel, setupControlledUnit, stopViewerSound, terminalPrint, terminalPrintln, toString

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

- Field Detail
  - ARRAY_TYPE_NONE
```
public static final int ARRAY_TYPE_NONE
```
    No array specified
    
    See Also:
    Constant Field Values
  - ARRAY_TYPE_POINT
```
public static final int ARRAY_TYPE_POINT
```
    Point array (single phone or multiple phones at same point)
    
    See Also:
    Constant Field Values
  - ARRAY_TYPE_LINE
```
public static final int ARRAY_TYPE_LINE
```
    Line array of two or more elements
    
    See Also:
    Constant Field Values
  - ARRAY_TYPE_PLANE
```
public static final int ARRAY_TYPE_PLANE
```
    Three or more Hydrophones all in the same plane
    
    See Also:
    Constant Field Values
  - ARRAY_TYPE_VOLUME
```
public static final int ARRAY_TYPE_VOLUME
```
    Four or more hydrophones not in the same plane.
    
    See Also:
    Constant Field Values
- Method Detail
  - getObserverObject
```
public PamObserver getObserverObject()
```
    Specified by:
    
    getObserverObject in interface PamObserver
    
    Returns:
    the actual observer. In most cases concrete classes will just return 'this' in response. The exception is the Threaded observer, which will return the single thread observer.
  - getArrayManager
```
public static ArrayManager getArrayManager()
```
  - notifyModelChanged
```
public void notifyModelChanged(int changeType)
```
    Description copied from class: PamControlledUnit
    
    General notification when the PAMGAURD model changes.
    
    Overrides:
    
    notifyModelChanged in class PamControlledUnit
    
    Parameters:
    changeType - type of change
  - getArrayFileType
```
public static java.lang.String getArrayFileType()
```
    Returns:
    Returns the arrayFileType.
  - getRecentArrays
```
public java.util.ArrayList<PamArray> getRecentArrays()
```
    Returns:
    Returns the recentArrays.
  - getArrayCount
```
public int getArrayCount()
```
  - showArrayDialog
```
public void showArrayDialog(java.awt.Frame parentFrame)
```
  - addArray
```
public void addArray(PamArray newArray)
```
  - setCurrentArray
```
public void setCurrentArray(PamArray array)
```
  - removeArray
```
public boolean removeArray(PamArray newArray)
```
  - getSettingsReference
```
public java.io.Serializable getSettingsReference()
```
    Specified by:
    
    getSettingsReference in interface PamSettings
    
    Returns:
    The serialisable object that will be stored
  - getSettingsVersion
```
public long getSettingsVersion()
```
    Specified by:
    
    getSettingsVersion in interface PamSettings
    
    Returns:
    An integer version number for the settings
  - getUnitName
```
public java.lang.String getUnitName()
```
    Description copied from class: PamControlledUnit
    
    Returns the name of the unit
    
    Specified by:
    
    getUnitName in interface PamSettings
    
    Overrides:
    
    getUnitName in class PamControlledUnit
    
    Returns:
    the name of the unit
  - getUnitType
```
public java.lang.String getUnitType()
```
    Specified by:
    
    getUnitType in interface PamSettings
    
    Overrides:
    
    getUnitType in class PamControlledUnit
    
    Returns:
    A Name specific to the type, e.g. Glick detector
  - restoreSettings
```
public boolean restoreSettings(PamControlledUnitSettings pamControlledUnitSettings)
```
    Specified by:
    
    restoreSettings in interface PamSettings
    
    Returns:
    true if successful The object performs final checks (if needed) and then casts the settings data pamcontrolledunitSettings.settings into the correct type and uses as required
  - getCurrentArray
```
public PamArray getCurrentArray()
```
    Returns:
    Returns the currentArray.
  - loadArrayFromFile
```
public static PamArray loadArrayFromFile(java.lang.String fileName)
```
  - saveArrayToFile
```
public static boolean saveArrayToFile(PamArray array)
```
  - getDepthControl
```
public DepthControl getDepthControl()
```
    Returns:
    the depthControl
  - setDepthControl
```
public void setDepthControl(DepthControl depthControl)
```
    Parameters:
    depthControl - the depthControl to set
  - getObserverName
```
public java.lang.String getObserverName()
```
    Specified by:
    
    getObserverName in interface PamObserver
  - getRequiredDataHistory
```
public long getRequiredDataHistory(PamObservable o,
                          java.lang.Object arg)
```
    Specified by:
    
    getRequiredDataHistory in interface PamObserver
    
    Parameters:
    o - PamObservable class requiring the data
    arg - optional argument from PamObservable
    
    Returns:
    time in milliseconds requried by data held in PamObservable
  - noteNewSettings
```
public void noteNewSettings()
```
    Specified by:
    
    noteNewSettings in interface PamObserver
  - removeObservable
```
public void removeObservable(PamObservable o)
```
    Description copied from interface: PamObserver
    
    called when an Observable (PamDataBlock) is removed from the system
    
    Specified by:
    
    removeObservable in interface PamObserver
  - setSampleRate
```
public void setSampleRate(float sampleRate,
                 boolean notify)
```
    Description copied from interface: PamObserver
    
    New sample rate
    
    Specified by:
    
    setSampleRate in interface PamObserver
    
    notify - Notify other PamObservers and PamObservables in the chain.
  - masterClockUpdate
```
public void masterClockUpdate(long milliSeconds,
                     long sampleNumber)
```
    Specified by:
    
    masterClockUpdate in interface PamObserver
  - update
```
public void update(PamObservable o,
          PamDataUnit arg)
```
    Description copied from interface: PamObserver
    
    Informs the PamObserver that new data have been added to the Observable class
    
    Specified by:
    
    update in interface PamObserver
    
    Parameters:
    o - Reference to the Observable (a PamDataBlock)
    arg - Reference to the new PamDataUnit
  - getArrayType
```
public int getArrayType()
```
    Returns:
    the type of the current array (point, planar, line, etc)
  - getArrayType
```
public int getArrayType(int phones)
```
    Parameters:
    phones -
    
    Returns:
    the type of a sub array of the current array (point, planar, line, etc)
  - getArrayShape
```
public int getArrayShape(PamArray array)
```
    Parameters:
    array - a PAMGUARD array
    
    Returns:
    the type of an array (point, plane, etc)
  - getArrayShape
```
public int getArrayShape(PamArray array,
                int phones)
```
    Parameters:
    array - a PAMGUARD array
    phones - a sub array of phones in the pam array.
    
    Returns:
    the type of an array (point, plane, etc)
  - getSpatiallyUniquePhones
```
public int getSpatiallyUniquePhones(PamArray array,
                           int phones)
```
    Take a list of phones and return a list of ones which are at unique positions.
    
    Parameters:
    array - hydrophone array
    phones - bitmap of hydrophone numbers
    
    Returns:
    bitmap of hydrophones which have a unique position.
  - getArrayDirections
```
public PamVector[] getArrayDirections()
```
    Get the principle direction vectors for the current array
    
    Returns:
    Array of vectors pointing along the array principle axes.
  - getArrayDirection
```
public PamVector[] getArrayDirection(int phones)
```
    Get the principle direction vectors for a sub set of hydrophones within the current array
    
    Parameters:
    phones - bitmap of hydrophones
    
    Returns:
    Array of vectors pointing along the array principle axes.
  - getArrayDirections
```
public PamVector[] getArrayDirections(PamArray array)
```
    Get a set of vectors which define the principle coordinates of an array
    
    Parameters:
    array - array
    
    Returns:
    array of vectors
  - getArrayDirections
```
public PamVector[] getArrayDirections(PamArray array,
                             int phones)
```
    Get a set of vectors which define the principle components of an array.
    For a point array, null is returned
    For a line array a vector pointing along the array in the direction closest to the y axis
    For a planar array a vector pointing as closely as possible to the y axis and a second vector, perpendicular to the first, obeying a right hand rule, in the plane will be returned.
    For a volumetric array, the above + the third vector (vec product of the other two).
    
    Parameters:
    array - Pamguard array
    phones - phones included in a sub array.
    
    Returns:
    up to three vectors defining the components of the array.
  - getArrayVectors
```
public PamVector[] getArrayVectors(PamArray array,
                          int phones)
```
  - getArrayTypeString
```
public static java.lang.String getArrayTypeString(int arrayType)
```
  - fillXMLData
```
public void fillXMLData(org.w3c.dom.Document doc,
               org.w3c.dom.Element xmlElement)
```
    Write Hydrophone array data into an XML element
    
    Parameters:
    doc - document root
    xmlElement - xml Element to fill with array data.
  - getHydrophoneDataBlock
```
public HydrophoneDataBlock getHydrophoneDataBlock()
```
    Called from the network receiver to create and assign some specific hydrophone streamer within an array and to clone a streamer to make a new one if necessary
    
    Parameters:
    buoyStats -
  - getStreamerDatabBlock
```
public StreamerDataBlock getStreamerDatabBlock()
```
  - getHydrophoneSQLLogging
```
public HydrophoneSQLLogging getHydrophoneSQLLogging()
```
  - getGPSDataBlock
```
public static GPSDataBlock getGPSDataBlock()
```
    Gets the GPS data block, if there is one. If no datablock is present then returns null;
    
    Returns:
    reference to the gps data block (if there is one)
  - showHydrophoneImportDialog
```
public void showHydrophoneImportDialog(javax.swing.JFrame guiFrame)
```
  - showStreamerImportDialog
```
public void showStreamerImportDialog(javax.swing.JFrame guiFrame)
```

Class ArrayManager

Field Summary

Method Summary

Methods inherited from class PamController.PamControlledUnit

Methods inherited from class java.lang.Object

Field Detail

ARRAY_TYPE_NONE

ARRAY_TYPE_POINT

ARRAY_TYPE_LINE

ARRAY_TYPE_PLANE

ARRAY_TYPE_VOLUME

Method Detail

getObserverObject

getArrayManager

notifyModelChanged

getArrayFileType

getRecentArrays

getArrayCount

showArrayDialog

addArray

setCurrentArray

removeArray

getSettingsReference

getSettingsVersion

getUnitName

getUnitType

restoreSettings

getCurrentArray

loadArrayFromFile

saveArrayToFile

getDepthControl

setDepthControl

getObserverName

getRequiredDataHistory

noteNewSettings

removeObservable

setSampleRate

masterClockUpdate

update

getArrayType

getArrayType

getArrayShape

getArrayShape

getSpatiallyUniquePhones

getArrayDirections

getArrayDirection

getArrayDirections

getArrayDirections

getArrayVectors

getArrayTypeString

fillXMLData

getHydrophoneDataBlock

getStreamerDatabBlock

getHydrophoneSQLLogging

getGPSDataBlock

showHydrophoneImportDialog

showStreamerImportDialog