org.orekit.errors
Enum OrekitAddonsMessages

java.lang.Object
  java.lang.Enum<OrekitAddonsMessages>
      org.orekit.errors.OrekitAddonsMessages

All Implemented Interfaces:

Serializable, Comparable<OrekitAddonsMessages>, Localizable

public enum OrekitAddonsMessages
extends Enum<OrekitAddonsMessages>
implements Localizable

OREKIT-ADDONS enumeration for localized messages formats.

Almost identical to OrekitMessages. If orekit-addons code is moved to orekit, since the class OrekitAddonsMessages will be missing, it will be easy to find out new messages are needed in Orekit without disrupting orekit or orekit-addons too much. Replaces the former solution that was using a OrekitMessages class in Orekit-addons but in a different package (too confusing); OrekitAddonsMessages is way more explicit, therefore, better.

Since:

1.1

Enum Constant Summary

ATTITUDE_LAW_ALREADY_IN_THE_SEQUENCE
Attitude law already in the sequence.

ILLEGAL_LINE
The line has illegal parameters.

MAIN_WAVE_MISSING
Main wave missing.

NO_TRANSITION_DATE
The date is not a transition date of the attitude sequence.

NOT_IMPLEMENTED
Not implemented yet.

NULL_VECTOR
The vector's norm can't be zero.

OUT_OF_RANGE_LATITUDE
out of range latitude : must be between -PI/2 and PI/2

UNABLE_TO_COMPUTE_GROUND_VELOCITY_DIRECTION

UNKNOWN_TRANSITION_PARAMETER
Unsupported transition points parameter name.

ZERO_COSLAT_SURFACE
The cosine of latitude elementary surface is equal to zero

Method Summary

String	getLocalizedString(Locale locale) Gets the localized string.
String	getSourceString() Gets the source (non-localized) string.
static OrekitAddonsMessages	valueOf(String name) Returns the enum constant of this type with the specified name.
static OrekitAddonsMessages[]	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

ILLEGAL_LINE

public static final OrekitAddonsMessages ILLEGAL_LINE

The line has illegal parameters.

NULL_VECTOR

public static final OrekitAddonsMessages NULL_VECTOR

The vector's norm can't be zero.

OUT_OF_RANGE_LATITUDE

public static final OrekitAddonsMessages OUT_OF_RANGE_LATITUDE

out of range latitude : must be between -PI/2 and PI/2

NO_TRANSITION_DATE

public static final OrekitAddonsMessages NO_TRANSITION_DATE

The date is not a transition date of the attitude sequence.

ZERO_COSLAT_SURFACE

public static final OrekitAddonsMessages ZERO_COSLAT_SURFACE

The cosine of latitude elementary surface is equal to zero

UNKNOWN_TRANSITION_PARAMETER

public static final OrekitAddonsMessages UNKNOWN_TRANSITION_PARAMETER

Unsupported transition points parameter name.

NOT_IMPLEMENTED

public static final OrekitAddonsMessages NOT_IMPLEMENTED

Not implemented yet.

MAIN_WAVE_MISSING

public static final OrekitAddonsMessages MAIN_WAVE_MISSING

Main wave missing.

UNABLE_TO_COMPUTE_GROUND_VELOCITY_DIRECTION

public static final OrekitAddonsMessages UNABLE_TO_COMPUTE_GROUND_VELOCITY_DIRECTION

ATTITUDE_LAW_ALREADY_IN_THE_SEQUENCE

public static final OrekitAddonsMessages ATTITUDE_LAW_ALREADY_IN_THE_SEQUENCE

Attitude law already in the sequence.

Method Detail

values

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

Returns:

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

valueOf

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

getSourceString

public String getSourceString()

Gets the source (non-localized) string.

Specified by:

getSourceString in interface Localizable

Returns:

the source string.

getLocalizedString

public String getLocalizedString(Locale locale)

Gets the localized string.

Specified by:

getLocalizedString in interface Localizable

Parameters:

locale - locale into which to get the string.

Returns:

the localized string or the source string if no localized version is available.