EnvironmentalData (Autonomous Unmanned Vehicle (AUV) Workbench Documentation)

java.lang.Object
- SonarVis.Metcast.MetcastTools.EnvironmentalData

```
public class EnvironmentalData
extends Object
```
This class is a grouping class that holds specfic environmental variables useful for sonar modeling (sound speed, sea temperature, wind speed, bathymetry, and significant wave height).

Version:

$Revision: 1.10 $

Author:

Scott Rosetti, LT USN
Contact: Don Brutzman (web.nps.navy.mil/~brutzman) brutzman@nps.navy.mil

See Also:

Bathymetry, MetcastClientMain, MetcastTestClient, ModelOutputFormatter, SceneGenerator, SeawaterTemp, SignificantWaveHeight, SonarSource, SonarTarget, SoundSpeed, Windspeed

Constructor Summary

Constructors
Constructor and Description
`EnvironmentalData(String time, double lat, double lon, double u, double v, double wave, String soundLev, String soundVal, String seaLev, String seaVal, String bathVal, double res)` Creates a new instance of EnvironmentalData
`EnvironmentalData(String time, double lat, double lon, double res, SoundSpeed pSsp, Bathymetry pBath)` Alternative constructor for EnvironmentalData; this provides only partial data.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Bathymetry`	`getBathymetry()` Returns bathymetry object
`String`	`getBathymetryString()` Returns bathymetry values
`double`	`getLatitude()` Returns request latitude
`double`	`getLongitude()` Returns request longitude
`double`	`getResolution()` Returns bathymetry resolution
`int`	`getSeaState()` Returns sea state
`double[]`	`getSeaTempLevels()` Returns sea temp levels.
`String`	`getSeaTempLevelString()` Returns sea temp depths
`double[]`	`getSeaTempValues()` Returns sea temp data values
`String`	`getSeaTempValueString()` Returns sea temp values
`SeawaterTemp`	`getSeawaterTemp()` Returns sea temp profile object
`SoundSpeed`	`getSoundSpeed()` Return sound speed object
`double[]`	`getSoundSpeedLevels()` Returns sound speed levels
`String`	`getSoundSpeedLevelString()` Returns sound speed depths
`double[]`	`getSoundSpeedValues()` Returns sound speed values
`String`	`getSoundSpeedValueString()` Returns sound speed values
`String`	`getTime()` Returns request time
`double`	`getUComponent()` Returns u component of wind speed
`String`	`getVagueWindDirection()` Calculates and returns vague wind direction
`double`	`getVComponent()` Returns v component of wind speed
`double`	`getWaveHeight()` Returns significant wave height
`double[]`	`getWindSpeed()` Returns windspeed (u and v components)
`double`	`getWindVelocity()` Returns wind velocity

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

- Constructor Detail
  - EnvironmentalData
```
public EnvironmentalData(String time,
                         double lat,
                         double lon,
                         double u,
                         double v,
                         double wave,
                         String soundLev,
                         String soundVal,
                         String seaLev,
                         String seaVal,
                         String bathVal,
                         double res)
```
    Creates a new instance of EnvironmentalData
    
    Parameters:
    
    time - The time of request.
    
    lat - The latitude of NW corner of requested area.
    
    lon - The longitude of NW corner of requested area.
    
    u - The wind speed u-component (north => south).
    
    v - The wind speed v-component (west => east).
    
    wave - The significant wave height.
    
    soundLev - The depths of sound speed data points.
    
    soundVal - The sound speed values.
    
    seaLev - The depths of sea temperature values.
    
    seaVal - The sea temperature values.
    
    bathVal - The bathymetry values.
    
    res - The resolution of bathymetry data (in degrees).
  - EnvironmentalData
```
public EnvironmentalData(String time,
                         double lat,
                         double lon,
                         double res,
                         SoundSpeed pSsp,
                         Bathymetry pBath)
```
    Alternative constructor for EnvironmentalData; this provides only partial data.
    
    Parameters:
    
    time - The time of request.
    
    lat - The latitude of NW corner of requested area.
    
    lon - The longitude of NW corner of requested area.
    
    res - The resolution of bathymetry data (in degrees).
    
    pSsp - The sound speed profile object.
    
    pBath - The significant wave hieght object.
- Method Detail
  - getWindSpeed
```
public double[] getWindSpeed()
```
    Returns windspeed (u and v components)
    
    Returns:
    
    The windspeed (u and v components).
  - getVagueWindDirection
```
public String getVagueWindDirection()
```
    Calculates and returns vague wind direction
    
    Returns:
    
    The vague wind direction.
  - getSoundSpeedLevels
```
public double[] getSoundSpeedLevels()
```
    Returns sound speed levels
    
    Returns:
    
    The sound speed levels.
  - getSoundSpeedValues
```
public double[] getSoundSpeedValues()
```
    Returns sound speed values
    
    Returns:
    
    The sound speed values.
  - getSeaTempLevels
```
public double[] getSeaTempLevels()
```
    Returns sea temp levels.
    
    Returns:
    
    The sea temp levels.
  - getSeaTempValues
```
public double[] getSeaTempValues()
```
    Returns sea temp data values
    
    Returns:
    
    The sea temp data values.
  - getResolution
```
public double getResolution()
```
    Returns bathymetry resolution
    
    Returns:
    
    The bathymetry resolution.
  - getTime
```
public String getTime()
```
    Returns request time
    
    Returns:
    
    The request time.
  - getLatitude
```
public double getLatitude()
```
    Returns request latitude
    
    Returns:
    
    The request latitude.
  - getLongitude
```
public double getLongitude()
```
    Returns request longitude
    
    Returns:
    
    The request longitude.
  - getUComponent
```
public double getUComponent()
```
    Returns u component of wind speed
    
    Returns:
    
    The u component of wind speed.
  - getVComponent
```
public double getVComponent()
```
    Returns v component of wind speed
    
    Returns:
    
    The v component of wind speed.
  - getWaveHeight
```
public double getWaveHeight()
```
    Returns significant wave height
    
    Returns:
    
    The significant wave height.
  - getSoundSpeedLevelString
```
public String getSoundSpeedLevelString()
```
    Returns sound speed depths
    
    Returns:
    
    The sound speed depths.
  - getSoundSpeedValueString
```
public String getSoundSpeedValueString()
```
    Returns sound speed values
    
    Returns:
    
    The sound speed values.
  - getSeaTempLevelString
```
public String getSeaTempLevelString()
```
    Returns sea temp depths
    
    Returns:
    
    The sea temp depths.
  - getSeaTempValueString
```
public String getSeaTempValueString()
```
    Returns sea temp values
    
    Returns:
    
    The sea temp values.
  - getBathymetryString
```
public String getBathymetryString()
```
    Returns bathymetry values
    
    Returns:
    
    The bathymetry values.
  - getSeaState
```
public int getSeaState()
```
    Returns sea state
    
    Returns:
    
    The sea state.
  - getWindVelocity
```
public double getWindVelocity()
```
    Returns wind velocity
    
    Returns:
    
    The wind velocity.
  - getSoundSpeed
```
public SoundSpeed getSoundSpeed()
```
    Return sound speed object
    
    Returns:
    
    The sound speed object.
  - getSeawaterTemp
```
public SeawaterTemp getSeawaterTemp()
```
    Returns sea temp profile object
    
    Returns:
    
    The sea temp profile object.
  - getBathymetry
```
public Bathymetry getBathymetry()
```
    Returns bathymetry object
    
    Returns:
    
    The bathymetry object.

Class EnvironmentalData

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

EnvironmentalData

EnvironmentalData

Method Detail

getWindSpeed

getVagueWindDirection

getSoundSpeedLevels

getSoundSpeedValues

getSeaTempLevels

getSeaTempValues

getResolution

getTime

getLatitude

getLongitude

getUComponent

getVComponent

getWaveHeight

getSoundSpeedLevelString

getSoundSpeedValueString

getSeaTempLevelString

getSeaTempValueString

getBathymetryString

getSeaState

getWindVelocity

getSoundSpeed

getSeawaterTemp

getBathymetry