agi.foundation.celestial

(agi.foundation.orbitpropagation-2023r1.jar)

Enum SphericalHarmonicsTideType

java.lang.Object

java.lang.Enum<SphericalHarmonicsTideType>

agi.foundation.celestial.SphericalHarmonicsTideType

All Implemented Interfaces:

Enumeration, Serializable, Comparable<SphericalHarmonicsTideType>

Deprecated.

The SphericalHarmonicsTideType enumeration is deprecated due to the addition of SolidTideModel classes.

@Deprecated
public enum SphericalHarmonicsTideType
extends Enum<SphericalHarmonicsTideType>
implements Enumeration

This type defines types of tidal effects used to model SphericalHarmonicGravity.

Enum Constant Summary

Enum Constants

Enum Constant and Description
NONE Deprecated. The gravity field is modeled without any tidal effects.
PERMANENT_TIDE_ONLY Deprecated. The gravity field is modeled including the effect of permanent solid tides.

Method Summary

Modifier and Type	Method and Description
static SphericalHarmonicsTideType	getDefault() Deprecated. Get the enum constant that is considered to be the default.
static SphericalHarmonicsTideType	getFromValue(int value) Deprecated. Get the enum constant that is associated with the given numeric value.
int	getValue() Deprecated. Get the numeric value associated with this enum constant.
static SphericalHarmonicsTideType	valueOf(String name) Deprecated. Returns the enum constant of this type with the specified name.
static SphericalHarmonicsTideType[]	values() Deprecated. 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

NONE

public static final SphericalHarmonicsTideType NONE

Deprecated.

The gravity field is modeled without any tidal effects. If the file includes data on the permanent tides that effect will be subtracted out.

PERMANENT_TIDE_ONLY

public static final SphericalHarmonicsTideType PERMANENT_TIDE_ONLY

Deprecated.

The gravity field is modeled including the effect of permanent solid tides.

Method Detail

values

public static SphericalHarmonicsTideType[] values()

Deprecated.

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 (SphericalHarmonicsTideType c : SphericalHarmonicsTideType.values())
    System.out.println(c);

Returns:

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

valueOf

public static SphericalHarmonicsTideType valueOf(String name)

Deprecated.

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

getValue

public int getValue()

Deprecated.

Get the numeric value associated with this enum constant.

Specified by:

getValue in interface Enumeration

Returns:

A numeric value.

getFromValue

@Nonnull
public static SphericalHarmonicsTideType getFromValue(int value)

Deprecated.

Get the enum constant that is associated with the given numeric value.

Parameters:

value - a numeric value.

Returns:

The enum constant associated with value.

getDefault

@Nonnull
public static SphericalHarmonicsTideType getDefault()

Deprecated.

Get the enum constant that is considered to be the default.

Returns:

The default enum constant.