Package org.orekit.forces.gravity.potential

Enum TideSystem

java.lang.Object

java.lang.Enum<TideSystem>

org.orekit.forces.gravity.potential.TideSystem

All Implemented Interfaces:

Serializable, Comparable<TideSystem>

public enum TideSystem
extends Enum<TideSystem>

Enumerate for tie systems.

Tide-systems are used to identify if the permanent tide is already present in the gravity field or if it should be handled when computing the solid tides force model.

Since:

6.0

Author:

Luc Maisonobe

See Also:

SphericalHarmonicsProvider

Enum Constant Summary

Enum Constants

Enum Constant	Description
TIDE_FREE	Constant for tide-free gravity fields.
UNKNOWN	Constant for unknown tide system.
ZERO_TIDE	Constant for zero-tide gravity fields.

Method Summary

Modifier and Type	Method	Description
static TideSystem	valueOf(String name)	Returns the enum constant of this type with the specified name.
static TideSystem[]	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

TIDE_FREE

public static final TideSystem TIDE_FREE

Constant for tide-free gravity fields.

Tide-free fields don't include the permanent tide, so it must be taken care of when computing the solid tides effects.

ZERO_TIDE

public static final TideSystem ZERO_TIDE

Constant for zero-tide gravity fields.

Zero-tide systems already include the permanent tide, so the solid tides effects must not add them, to avoid it been counted twice.

UNKNOWN

public static final TideSystem UNKNOWN

Constant for unknown tide system.

Method Detail

values

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

Returns:

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

valueOf

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