Package org.tinfour.svm

Enum SvmBathymetryModel

java.lang.Object

java.lang.Enum<SvmBathymetryModel>

org.tinfour.svm.SvmBathymetryModel

All Implemented Interfaces:

Serializable, Comparable<SvmBathymetryModel>

public enum SvmBathymetryModel
extends Enum<SvmBathymetryModel>

Indicates the form in which the bathymetry data was specified.

Enum Constant Summary

Enum Constants

Enum Constant	Description
Depth	Soundings are specified as depth given as either uniformly positive or uniformly negative numbers indicating depths below the surface.
Elevation	Soundings are specified as elevations referenced to to the vertical datum used by the source data, usually Mean Sea Level (MSL).

Method Summary

Modifier and Type	Method	Description
boolean	isDepth()	Indicates whether the model represents depth values (as opposed to elevation).
static SvmBathymetryModel	lenientValueOf(String s)	Return the value indicated by the string or a null if the string is empty of does not include a recognizable value.
static SvmBathymetryModel	valueOf(String name)	Returns the enum constant of this type with the specified name.
static SvmBathymetryModel[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

Depth

public static final SvmBathymetryModel Depth

Soundings are specified as depth given as either uniformly positive or uniformly negative numbers indicating depths below the surface. A value of zero indicates the surface.

Elevation

public static final SvmBathymetryModel Elevation

Soundings are specified as elevations referenced to to the vertical datum used by the source data, usually Mean Sea Level (MSL).

Method Detail

values

public static SvmBathymetryModel[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (SvmBathymetryModel c : SvmBathymetryModel.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static SvmBathymetryModel valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

lenientValueOf

public static SvmBathymetryModel lenientValueOf(String s)

Return the value indicated by the string or a null if the string is empty of does not include a recognizable value.

Parameters:

s - a valid string

Returns:

a valid instance of the enumeration or a null if no value can be determined.

isDepth

public boolean isDepth()

Indicates whether the model represents depth values (as opposed to elevation).

Returns:

true if the model represents depth values; otherwise, false.