Package gov.nasa.gsfc.spdf.ssc

Enum ExternalBFieldModel

java.lang.Object

java.lang.Enum<ExternalBFieldModel>

gov.nasa.gsfc.spdf.ssc.ExternalBFieldModel

All Implemented Interfaces:

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

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

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

Note: The String values for this enumeration cannot be arbitrarily assigned. They must match the values expected by other parts of the SSC software.

Version:

$Revison: $

Author:

B. Harris

Enum Constant Summary

Enum Constants

Enum Constant	Description
T87	Tsyganenko 87 model (see Magnetic Field Models in the Satellite Situation Center Software).
T89c	Tsyganenko 89c model (see Magnetic Field Models in the Satellite Situation Center Software).
T96	Tsyganenko 96 model (see Magnetic Field Models in the Satellite Situation Center Software).

Method Summary

Modifier and Type	Method	Description
static ExternalBFieldModel	fromValue(java.lang.String value)	Provides the model corresponding to the given String value.
java.lang.String	toString()	Provides a string representation of this model.
java.lang.String	value()	Provides the String value corresponding to this model.
static ExternalBFieldModel	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static ExternalBFieldModel[]	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

T87

public static final ExternalBFieldModel T87

Tsyganenko 87 model (see Magnetic Field Models in the Satellite Situation Center Software).

T89c

public static final ExternalBFieldModel T89c

Tsyganenko 89c model (see Magnetic Field Models in the Satellite Situation Center Software).

T96

public static final ExternalBFieldModel T96

Tsyganenko 96 model (see Magnetic Field Models in the Satellite Situation Center Software).

Method Detail

values

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

Returns:

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

valueOf

public static ExternalBFieldModel 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 java.lang.String value()

Provides the String value corresponding to this model.

Returns:

String value corresponding to this model.

fromValue

public static ExternalBFieldModel fromValue(java.lang.String value)

Provides the model corresponding to the given String value.

Parameters:

value - String value corresponding to a model

Returns:

ExternalBFieldModel 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<ExternalBFieldModel>

Returns:

a string representation of this model