environmental

Class ConstantDataSource

java.lang.Object

environmental.ConstantDataSource

All Implemented Interfaces:

EnvironmentDataSource

Direct Known Subclasses:

ConstantDataSourceStandardAtmosphere

public class ConstantDataSource
extends Object
implements EnvironmentDataSource

A class, implementing EnviroDataSource which returns constant values for all environmental parameters at all Lat/Lon locations.

Nested Class Summary

Nested classes/interfaces inherited from interface environmental.EnvironmentDataSource

EnvironmentDataSource.LatitudeLongitudeRectangle

Field Summary

Fields

Modifier and Type	Field and Description
static double	METERS_PER_NAUTMILE
static double	SECS_PER_HOUR

Fields inherited from interface environmental.EnvironmentDataSource

AIR, AIR_EW, AIR_NS, AIR_PRESS, AIR_TEMP, AIR_UD, CURRENT, CURRENT_EW, CURRENT_NS, CURRENT_UD, DENS_ANOM, EW, NS, SALINITY, SEASTATE, SURF_ELEV, UD, WATER_TEMP

Constructor Summary

Constructors

Constructor and Description
ConstantDataSource(EnvironConstantsDialog.ConstantValues values)

Method Summary

Modifier and Type	Method and Description
protected double	getAirPressure(double lat, double lon, double depthAltitude)
protected double	getAirTemperature(double lat, double lon, double depthAltitude)
EnvironmentDataSource.LatitudeLongitudeRectangle[]	getCoverage() Get lat/lon coverage rectangle(s)
String	getDescription()
int	getParameterMask() Return the parameters which this source can/is-instructed-to provide
double	getVariable(int var, double lat, double lon, double depth, Date date) Get environtal parameter at specified location and date
double	getVariable(int var, double lat, double lon, double depth, long time) Get environtal parameter at specified location and date
double[]	getVariableAr(int var, double lat, double lon, double depth, Date date) Get environtal parameter array at specified location and date.
double[]	getVariableAr(int var, double lat, double lon, double depth, long time) Get environtal parameter array at specified location and date.
void	setDescription(String s) Add a description string tag to this data source
void	setParamMask(int mask) Set the parameter which this source can/is-instructed-to provide

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

METERS_PER_NAUTMILE

public static final double METERS_PER_NAUTMILE

See Also:

Constant Field Values

SECS_PER_HOUR

public static final double SECS_PER_HOUR

See Also:

Constant Field Values

Constructor Detail

ConstantDataSource

public ConstantDataSource(EnvironConstantsDialog.ConstantValues values)

Method Detail

getCoverage

public EnvironmentDataSource.LatitudeLongitudeRectangle[] getCoverage()

Get lat/lon coverage rectangle(s)

Specified by:

getCoverage in interface EnvironmentDataSource

Returns:

rectangle array

getParameterMask

public int getParameterMask()

Return the parameters which this source can/is-instructed-to provide

Specified by:

getParameterMask in interface EnvironmentDataSource

Returns:

parameter mask

setParamMask

public void setParamMask(int mask)

Set the parameter which this source can/is-instructed-to provide

Specified by:

setParamMask in interface EnvironmentDataSource

getDescription

public String getDescription()

Specified by:

getDescription in interface EnvironmentDataSource

Returns:

data source description

setDescription

public void setDescription(String s)

Add a description string tag to this data source

Specified by:

setDescription in interface EnvironmentDataSource

Parameters:

s -

getVariable

public double getVariable(int var,
                          double lat,
                          double lon,
                          double depth,
                          Date date)
                   throws EnviroException

Get environtal parameter at specified location and date

Specified by:

getVariable in interface EnvironmentDataSource

Parameters:

var - parameter enum

lat - latitude (dec deg)

lon - longitude (dec deg)

depth - vertical postion (meters)

date - simulation tod

Returns:

environmental parameter

Throws:

EnviroException

getVariable

public double getVariable(int var,
                          double lat,
                          double lon,
                          double depth,
                          long time)
                   throws EnviroException

Get environtal parameter at specified location and date

Specified by:

getVariable in interface EnvironmentDataSource

Parameters:

var - parameter enum

lat - latitude (dec deg)

lon - longitude (dec deg)

depth - vertical postion (meters)

time - simulation relative time

Returns:

environmental parameter

Throws:

EnviroException

getVariableAr

public double[] getVariableAr(int var,
                              double lat,
                              double lon,
                              double depth,
                              Date date)
                       throws EnviroException

Get environtal parameter array at specified location and date. Only valid for 2 and 3D params

Specified by:

getVariableAr in interface EnvironmentDataSource

Parameters:

var - parameter enum

lat - latitude (dec deg)

lon - longitude (dec deg)

depth - vertical postion (meters)

date - simulation tod

Returns:

environmental parameter

Throws:

EnviroException

getVariableAr

public double[] getVariableAr(int var,
                              double lat,
                              double lon,
                              double depth,
                              long time)
                       throws EnviroException

Get environtal parameter array at specified location and date. Only valid for 2 and 3D params

Specified by:

getVariableAr in interface EnvironmentDataSource

Parameters:

var - parameter enum

lat - latitude (dec deg)

lon - longitude (dec deg)

depth - vertical postion (meters)

time - simulation relative time

Returns:

environmental parameter

Throws:

EnviroException

getAirTemperature

protected double getAirTemperature(double lat,
                                   double lon,
                                   double depthAltitude)
                            throws EnviroException

Throws:

EnviroException

getAirPressure

protected double getAirPressure(double lat,
                                double lon,
                                double depthAltitude)
                         throws EnviroException

Throws:

EnviroException