ucar.nc2.constants

Enum FeatureType

java.lang.Object

java.lang.Enum<FeatureType>

ucar.nc2.constants.FeatureType

All Implemented Interfaces:

Serializable, Comparable<FeatureType>

public enum FeatureType
extends Enum<FeatureType>

Type-safe enumeration of CDM Feature types, aka "Scientific Data Types".

Author:

john caron

See Also:

CDM Feature Types

Enum Constant Summary

Enum Constants

Enum Constant and Description
ANY No specific type
ANY_POINT Any of the point types
FMRC
GRID Gridded Data
IMAGE Image data
NONE deprecated - use ANY
POINT Point data
PROFILE Profile data
RADIAL Radial data
SECTION Section data
STATION Station data
STATION_PROFILE Stations of profiles
STATION_RADIAL experimental
SWATH Swath Data
TRAJECTORY Trajectory data
UGRID

Method Summary

Methods

Modifier and Type	Method and Description
static FeatureType	getType(String name) Find the FeatureType that matches this name.
boolean	isGridFeatureType()
boolean	isPointFeatureType() Is this a Point feature type?
boolean	isUnstructuredGridFeatureType()
static FeatureType	valueOf(String name) Returns the enum constant of this type with the specified name.
static FeatureType[]	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

ANY

public static final FeatureType ANY

No specific type

GRID

public static final FeatureType GRID

Gridded Data

RADIAL

public static final FeatureType RADIAL

Radial data

SWATH

public static final FeatureType SWATH

Swath Data

IMAGE

public static final FeatureType IMAGE

Image data

ANY_POINT

public static final FeatureType ANY_POINT

Any of the point types

POINT

public static final FeatureType POINT

Point data

PROFILE

public static final FeatureType PROFILE

Profile data

SECTION

public static final FeatureType SECTION

Section data

STATION

public static final FeatureType STATION

Station data

STATION_PROFILE

public static final FeatureType STATION_PROFILE

Stations of profiles

TRAJECTORY

public static final FeatureType TRAJECTORY

Trajectory data

STATION_RADIAL

public static final FeatureType STATION_RADIAL

experimental

FMRC

public static final FeatureType FMRC

UGRID

public static final FeatureType UGRID

NONE

public static final FeatureType NONE

deprecated - use ANY

Method Detail

values

public static FeatureType[] 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 (FeatureType c : FeatureType.values())
    System.out.println(c);

Returns:

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

valueOf

public static FeatureType 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

getType

public static FeatureType getType(String name)

Find the FeatureType that matches this name.

Parameters:

name - find FeatureType with this name.

Returns:

FeatureType or null if no match.

isPointFeatureType

public boolean isPointFeatureType()

Is this a Point feature type?

Returns:

true if this is a Point feature type

isGridFeatureType

public boolean isGridFeatureType()

isUnstructuredGridFeatureType

public boolean isUnstructuredGridFeatureType()