Streamer

java.lang.Object
- Array.Streamer

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable
```
public class Streamer
extends java.lang.Object
implements java.io.Serializable, java.lang.Cloneable
```
Contains information on an individual streamer - i.e. something towed through the water. Each hydrophone element will belong to one streamer.

Author:

Doug Gillespie

See Also:
Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`REF_BUOY`
`static int`	`REF_SHIP_GPS` The streamer doesn't need to hold the reference to the locator though That's held within the MasterLocator - still need to work out how to serialise that with the array settings.
`static long`	`serialVersionUID`

Constructor Summary

Constructors
Constructor and Description
`Streamer(int streamerIndex)`
`Streamer(int streamerIndex, double x, double y, double z, double dx, double dy, double dz)`
`Streamer(Streamer firstStreamer, int streamerIndex, java.lang.String streamerName)`

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`equals(Streamer s2)` Check if two streamers have identical values for all parameters
`static Streamer`	`getAverage(Streamer sd1, Streamer sd2)`
`double`	`getCoordinate(int iCoordinate)`
`double[]`	`getCoordinateError()`
`double`	`getCoordinateError(int iCoordinate)`
`double[]`	`getCoordinates()`
`PamVector`	`getCoordinateVector()`
`double`	`getDx()`
`double`	`getDy()`
`double`	`getDz()`
`PamVector`	`getErrorVector()`
`java.lang.Double`	`getHeading()`
`HydrophoneLocator`	`getHydrophoneLocator()`
`HydrophoneOriginMethod`	`getHydrophoneOrigin()`
`LocatorSettings`	`getLocatorSettings()` Get the settings for the currently set locator method.
`LocatorSettings`	`getLocatorSettings(java.lang.Class locatorClass)` Get the locator settings for the currently selected hydrophone locator method
`OriginSettings`	`getOriginSettings()` Get the hydrophone origin settings for the currently selected origin method.
`OriginSettings`	`getOriginSettings(java.lang.Class originClass)` Get the hydrophone origin settings for a specific origin method class.
`java.lang.Double`	`getPitch()`
`java.lang.Double`	`getRoll()`
`int`	`getStreamerHydrophones()` Get a list of hydrophones that go with this streamer.
`int`	`getStreamerIndex()`
`java.lang.String`	`getStreamerName()`
`double`	`getX()`
`double`	`getY()`
`double`	`getZ()`
`boolean`	`isEnableOrientation()`
`void`	`makeStreamerDataUnit()` Make a streamer data unit and add it to the data block.
`void`	`notifyModelChanged(int changeType, boolean initComplete)`
`void`	`setCoordinate(int iCoordinate, double coordinate)`
`void`	`setCoordinateError(int iCoordinate, double error)`
`void`	`setCoordinateErrors(double[] coordinateErrors)`
`void`	`setCoordinates(double[] coordinates)`
`void`	`setDx(double dx)`
`void`	`setDy(double dy)`
`void`	`setDz(double dz)`
`void`	`setEnableOrientation(boolean enableOrientation)`
`void`	`setHeading(java.lang.Double heading)`
`void`	`setHydrophoneLocator(HydrophoneLocator hydrophoneLocator)`
`void`	`setHydrophoneOrigin(HydrophoneOriginMethod hydrophoneOrigin)`
`void`	`setLocatorSettings(LocatorSettings locatorSettings)` Set the locator settings.
`void`	`setOriginSettings(OriginSettings originSettings)` Set the origin settings.
`void`	`setPitch(java.lang.Double pitch)`
`void`	`setRoll(java.lang.Double roll)`
`void`	`setStreamerName(java.lang.String streamerName)`
`void`	`setupLocator(PamArray pamArray)` Set up the hydrophone locator.
`void`	`setX(double x)`
`void`	`setY(double x)`
`void`	`setZ(double x)`
`java.lang.String`	`toString()`

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

- Field Detail
  - serialVersionUID
```
public static final long serialVersionUID
```
    See Also:
    Constant Field Values
  - REF_SHIP_GPS
```
public static final int REF_SHIP_GPS
```
    The streamer doesn't need to hold the reference to the locator though That's held within the MasterLocator - still need to work out how to serialise that with the array settings.
    
    See Also:
    Constant Field Values
  - REF_BUOY
```
public static final int REF_BUOY
```
    See Also:
    Constant Field Values
- Constructor Detail
  - Streamer
```
public Streamer(int streamerIndex,
        double x,
        double y,
        double z,
        double dx,
        double dy,
        double dz)
```
    Parameters:
    x - x coordinate of streamer (m)
    dx - estimated error on x location of streamer (m)
    dy - estimated error on y location of streamer (m)
    dz - estimated error on z location of streamer (m)
  - Streamer
```
public Streamer(int streamerIndex)
```
  - Streamer
```
public Streamer(Streamer firstStreamer,
        int streamerIndex,
        java.lang.String streamerName)
```
- Method Detail
  - setCoordinates
```
public void setCoordinates(double[] coordinates)
```
  - setCoordinate
```
public void setCoordinate(int iCoordinate,
                 double coordinate)
```
  - getCoordinates
```
public double[] getCoordinates()
```
  - getCoordinate
```
public double getCoordinate(int iCoordinate)
```
  - getCoordinateError
```
public double[] getCoordinateError()
```
  - getCoordinateError
```
public double getCoordinateError(int iCoordinate)
```
  - setCoordinateErrors
```
public void setCoordinateErrors(double[] coordinateErrors)
```
  - setCoordinateError
```
public void setCoordinateError(int iCoordinate,
                      double error)
```
  - getCoordinateVector
```
public PamVector getCoordinateVector()
```
  - getErrorVector
```
public PamVector getErrorVector()
```
  - setX
```
public void setX(double x)
```
  - setY
```
public void setY(double x)
```
  - setZ
```
public void setZ(double x)
```
  - setDx
```
public void setDx(double dx)
```
  - setDy
```
public void setDy(double dy)
```
  - setDz
```
public void setDz(double dz)
```
  - getX
```
public double getX()
```
  - getY
```
public double getY()
```
  - getZ
```
public double getZ()
```
  - getDx
```
public double getDx()
```
  - getDy
```
public double getDy()
```
  - getDz
```
public double getDz()
```
  - getStreamerName
```
public java.lang.String getStreamerName()
```
  - setStreamerName
```
public void setStreamerName(java.lang.String streamerName)
```
  - getHydrophoneLocator
```
public HydrophoneLocator getHydrophoneLocator()
```
    Returns:
    the hydrophoneLocator
  - setHydrophoneLocator
```
public void setHydrophoneLocator(HydrophoneLocator hydrophoneLocator)
```
    Parameters:
    hydrophoneLocator - the hydrophoneLocator to set
  - getLocatorSettings
```
public LocatorSettings getLocatorSettings()
```
    Get the settings for the currently set locator method.
    
    Returns:
    settings for the current locator method.
  - getLocatorSettings
```
public LocatorSettings getLocatorSettings(java.lang.Class locatorClass)
```
    Get the locator settings for the currently selected hydrophone locator method
    
    Parameters:
    locatorClass - class for the current locator method
    
    Returns:
    settings for the specified locator method.
  - setLocatorSettings
```
public void setLocatorSettings(LocatorSettings locatorSettings)
```
    Set the locator settings. Streamer actually holds a list of locator settings for all the different available locators, so will check that list and remove any ones that have the same locator class before adding this to the list.
    
    Parameters:
    locatorSettings - new locator settings.
  - setOriginSettings
```
public void setOriginSettings(OriginSettings originSettings)
```
    Set the origin settings. Streamer actually holds a list of origin settings for all the different origin types, so will check there aren't any for that type and remove them from the master list before adding these.
    
    Parameters:
    originSettings - new origin settings to store.
  - getOriginSettings
```
public OriginSettings getOriginSettings()
```
    Get the hydrophone origin settings for the currently selected origin method.
    
    Returns:
    origin settings for current method
  - getOriginSettings
```
public OriginSettings getOriginSettings(java.lang.Class originClass)
```
    Get the hydrophone origin settings for a specific origin method class.
    
    Parameters:
    originClass - origin method class.
    
    Returns:
    origin settings for that class (or null if there are none).
  - setupLocator
```
public void setupLocator(PamArray pamArray)
```
    Set up the hydrophone locator. Note that only the locatorSettings are serialised in psf files, to it's necessary to construct the actual locator and it's corresponding hydrophone origin system.
    Some locators (such as static, are also no longer used, since they are superseded by a fixed hydrophone origin and a rigid locator.
    
    Parameters:
    pamArray -
  - getHydrophoneOrigin
```
public HydrophoneOriginMethod getHydrophoneOrigin()
```
    Returns:
    the hydrophoneOrigin
  - setHydrophoneOrigin
```
public void setHydrophoneOrigin(HydrophoneOriginMethod hydrophoneOrigin)
```
    Parameters:
    hydrophoneOrigin - the hydrophoneOrigin to set
  - notifyModelChanged
```
public void notifyModelChanged(int changeType,
                      boolean initComplete)
```
  - makeStreamerDataUnit
```
public void makeStreamerDataUnit()
```
    Make a streamer data unit and add it to the data block.
  - getHeading
```
public java.lang.Double getHeading()
```
    Returns:
    the heading
  - setHeading
```
public void setHeading(java.lang.Double heading)
```
    Parameters:
    heading - the heading to set
  - getPitch
```
public java.lang.Double getPitch()
```
    Returns:
    the pitch in degrees
  - setPitch
```
public void setPitch(java.lang.Double pitch)
```
    Parameters:
    pitch - the pitch to set in degrees
  - getRoll
```
public java.lang.Double getRoll()
```
    Returns:
    the roll in degrees
  - setRoll
```
public void setRoll(java.lang.Double roll)
```
    Parameters:
    roll - the roll to set (degrees)
  - isEnableOrientation
```
public boolean isEnableOrientation()
```
    Returns:
    the enableOrientation
  - setEnableOrientation
```
public void setEnableOrientation(boolean enableOrientation)
```
    Parameters:
    enableOrientation - the enableOrientation to set
  - getStreamerIndex
```
public int getStreamerIndex()
```
    Returns:
    the streamerIndex
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - getAverage
```
public static Streamer getAverage(Streamer sd1,
                  Streamer sd2)
```
  - getStreamerHydrophones
```
public int getStreamerHydrophones()
```
    Get a list of hydrophones that go with this streamer.
    
    Returns:
  - equals
```
public boolean equals(Streamer s2)
```
    Check if two streamers have identical values for all parameters
    
    Parameters:
    s2 -
    
    Returns:

Class Streamer

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

serialVersionUID

REF_SHIP_GPS

REF_BUOY

Constructor Detail

Streamer

Streamer

Streamer

Method Detail

setCoordinates

setCoordinate

getCoordinates

getCoordinate

getCoordinateError

getCoordinateError

setCoordinateErrors

setCoordinateError

getCoordinateVector

getErrorVector

setX

setY

setZ

setDx

setDy

setDz

getX

getY

getZ

getDx

getDy

getDz

getStreamerName

setStreamerName

getHydrophoneLocator

setHydrophoneLocator

getLocatorSettings

getLocatorSettings

setLocatorSettings

setOriginSettings

getOriginSettings

getOriginSettings

setupLocator

getHydrophoneOrigin

setHydrophoneOrigin

notifyModelChanged

makeStreamerDataUnit

getHeading

setHeading

getPitch

setPitch

getRoll

setRoll

isEnableOrientation

setEnableOrientation

getStreamerIndex

toString

getAverage

getStreamerHydrophones

equals