dk.dmi.jog
Class Station

java.lang.Object
  dk.dmi.jog.Station

public class Station

extends Object

An oceanographic station. Missing values are represented by Float.NaN.

Method Summary

boolean	equals(Object o) Compares this Station to the specified Object.
Date	getDate() Returns the time of this Station.
static Station	getInstance(String iid, String sid, float x0, float y0, Date t, Profile[] dataset) Returns a Station representation of the arguments.
String	getInstituteID() Returns the institute ID of this Station.
float	getLatitude() Returns the latitude of this Station.
float	getLongitude() Returns the longitude of this Station.
String[]	getParameterIDs() Returns the parameter IDs of this Station.
Profile	getProfile(String pid) Returns a Profile from this Station corresponding to the specified parameter id.
Profile[]	getProfiles() Returns the Profiles of this Station.
String	getStationID() Returns the station ID of this Station.
int	hashCode()
Station	interpolateVerticalLevels(float[] z) Returns a Station with values interpolated to the values in z.
String	toString() Returns a String representation of this Station.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

equals

public boolean equals(Object o)

Compares this Station to the specified Object. The result is true if and only if the argument is not null and is a Station which is identical to this Station.

Parameters:

o - the Object to be compared for equality with this Station.

Returns:

true if the objects are identical; false otherwise.

getDate

public Date getDate()

Returns the time of this Station.

Returns:

the time of this Station.

getInstance

public static Station getInstance(String iid,
                                  String sid,
                                  float x0,
                                  float y0,
                                  Date t,
                                  Profile[] dataset)

Returns a Station representation of the arguments. Missing values are Float.NaN.

Parameters:

iid - institute ID.

sid - station ID.

x0 - station longitude.

y0 - station latitude.

t - station time.

dataset - array of data profiles (eg. temperature, salinity).

Returns:

a Station representation of the arguments. Missing values are Float.NaN.

getInstituteID

public String getInstituteID()

Returns the institute ID of this Station.

Returns:

the institute ID of this Station.

getLatitude

public float getLatitude()

Returns the latitude of this Station.

Returns:

the latitude of this Station.

getLongitude

public float getLongitude()

Returns the longitude of this Station.

Returns:

the longitude of this Station.

getParameterIDs

public String[] getParameterIDs()

Returns the parameter IDs of this Station.

Returns:

the parameter IDs of this Station.

getProfile

public Profile getProfile(String pid)

Returns a Profile from this Station corresponding to the specified parameter id.

Returns:

a Profile from this Station corresponding to the specified parameter id.

Throws:

NoSuchElementException - if no Profile of the given parameter ID is present in this Station.

getProfiles

public Profile[] getProfiles()

Returns the Profiles of this Station.

Returns:

the Profiles of this Station.

getStationID

public String getStationID()

Returns the station ID of this Station.

Returns:

the station ID of this Station.

hashCode

public int hashCode()

interpolateVerticalLevels

public Station interpolateVerticalLevels(float[] z)

Returns a Station with values interpolated to the values in z.

Parameters:

z - array containing vertical levels to interpolate this Station to.

Returns:

a Station with values from this Station interpolated to the values in z.

toString

public String toString()

Returns a String representation of this Station.

Returns:

a String representation of this Station.