gov.nasa.gsfc.spdf.ssc
Enum InternalBFieldModel

java.lang.Object
  java.lang.Enum<InternalBFieldModel>
      gov.nasa.gsfc.spdf.ssc.InternalBFieldModel

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<InternalBFieldModel>

public enum InternalBFieldModel
extends java.lang.Enum<InternalBFieldModel>

This class represents the different internal B field models supported by SSC.

Version:

$Revison: $

Author:

B. Harris

Enum Constant Summary

IGRF
International Geomagnetic Reference Field model.

SIMPLE_DIPOLE
Simple Dipole model.

Method Summary

static InternalBFieldModel	fromValue(int value) Provides the model corresponding to the given integer value.
java.lang.String	toString() Provides a string representation of this model.
int	value() Provides the integer value corresponding to this model.
static InternalBFieldModel	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static InternalBFieldModel[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

IGRF

public static final InternalBFieldModel IGRF

International Geomagnetic Reference Field model.

SIMPLE_DIPOLE

public static final InternalBFieldModel SIMPLE_DIPOLE

Simple Dipole model.

Method Detail

values

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

Returns:

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

valueOf

public static InternalBFieldModel valueOf(java.lang.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:

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

java.lang.NullPointerException - if the argument is null

value

public int value()

Provides the integer value corresponding to this model.

Returns:

integer value corresponding to this model.

fromValue

public static InternalBFieldModel fromValue(int value)

Provides the model corresponding to the given integer value.

Parameters:

value - integer value corresponding to a model

Returns:

InternalBFieldModel corresponding to the given value

Throws:

java.lang.IllegalArgumentException - if the given value does not correspond to any model

toString

public java.lang.String toString()

Provides a string representation of this model.

Overrides:

toString in class java.lang.Enum<InternalBFieldModel>

Returns:

a string representation of this model