fr.cnes.sirius.patrius.exception.util
Enum PatriusMessages

java.lang.Object
  java.lang.Enum<PatriusMessages>
      fr.cnes.sirius.patrius.exception.util.PatriusMessages

All Implemented Interfaces:

Serializable, Comparable<PatriusMessages>, Localizable

public enum PatriusMessages
extends Enum<PatriusMessages>
implements Localizable

Enumeration for localized messages formats used in exceptions messages.

This class is roughly the same as the one in OREKIT. It adds PATRIUS library messages in the same manner as OREKIT does. Users should see OREKIT documentation about localized messages format.

Since:

1.0

Version:

$Id: PatriusMessages.java 15924 2016-04-18 08:37:21Z galpin $

Author:

Sylvain VRESK

Use sample :

...
PatriusMessages myMessage = PatriusMessages.PDB_MY_MESSAGE;
System.out.println(myMessage.getLocalizedString(Locale.FRENCH));
...

Concurrency :

immutable

Enum Constant Summary

PDB_ALREADY_A_MAIN_PART
Already a main Part.

PDB_ANGLE_OUTSIDE_INTERVAL
Angle outside interval message.

PDB_BAD_LENGTH
Bad input length

PDB_BAD_PARENT_FRAME
The main part's frame must be the same as the SpacecraftState's definition frame.

PDB_CLOSE_CONSECUTIVE_DIRECTIONS
Two consecutive directions are too close to create the zone

PDB_CROSSING_ARCS
Two consecutive directions are too close to create the zone

PDB_EASTING_OUT_OF_RANGE
easting value out of range

PDB_FOO_MESSAGE
A foo message for testing purpose.

PDB_GEODETIC_PARAMETERS_COMPUTATION_FAILED
The geodetic altitude and latitude computation failed.

PDB_INVALID_ANGLE_INTERVAL
Invalid angle interval message.

PDB_INVALID_DATE
Invalid date specified.

PDB_INVALID_VECTORS_FOR_SECTOR_FIELD
Invalid vectors for sector field of view creation.

PDB_IONO_DATE_OUT_OF_FILE
iono invalid date.

PDB_LATITUDE_CLOSE_90
the latitude is close or over -/+ 90°.

PDB_LATITUDE_OUT_OF_RANGE
the latitude is out of range

PDB_MAIN_FRAME_HAS_NO_PARENT
The main part's frame must have a parent.

PDB_MULTI_SAT_DATE_MISMATCH
For multi propagation purposes, added states date is different from others states date

PDB_NO_AERO_GLOBAL_MASS_PROPERTIES
Error message for aero drag and lift model: no required aero properties

PDB_NO_AERO_MASS_PROPERTIES
Error message for aero model: no required aero properties

PDB_NO_GEOMETRY_PROPERTY
Error message for masking computations : no required geometry property

PDB_NO_MAIN_PART
No main Part.

PDB_NO_RADIATIVE_MASS_PROPERTIES
Error message for radiative model: no required radiative properties

PDB_NO_RF_PROPERTY
Error message for RF link budget model : no required RF property

PDB_NO_SENSOR_PROPERTY
Error message for extrema sight axis detector using an assembly and a part name : no required SENSOR property

PDB_NORTHING_OUT_OF_RANGE
northing value out of range

PDB_NOT_IMPLEMENTED
Error message for not supported method

PDB_NOT_INERTIAL_FRAME
The frame must be pseudo inertial.

PDB_NULL_STATE_ID
For multi propagation purposes, the input sat Id is null or empty

PDB_NULL_TEMPERATURE
The absolute temperature can't be zero or lower

PDB_ORBIT_TOLERENCE_LENGTH
For multi propagation purposes, the added tolerance is not of dimension-6

PDB_OSC_MEAN_CVG_ERROR
Osculating to mean conversion convergence error.

PDB_PART_DONT_EXIST
No part with this name.

PDB_PART_NAME_EXISTS
A part with this name already exists.

PDB_POINTS_TOO_CLOSE
points too close, cannot define azimuth.

PDB_PROPAGATION_NO_REENTRY
For Stela purposes, reentry did not occur after n steps

PDB_PROPERTY_ALREADY_EXIST
A property of this type already exists in this part.

PDB_REDUNDANT_AERO_PROPERTIES
Error message for aero model: redundant aero properties

PDB_REDUNDANT_RADIATIVE_PROPERTIES
Error message for radiative model: redundant radiative properties

PDB_SAT_ID_ALREADY_USED
For multi propagation purposes, the user try to add a state with a name already added

PDB_SIMPSON_RULE_FAILED
The Simpson rule computation failed.

PDB_SQUARING_FAILED
The squaring computation failed.

PDB_TOO_FEW_DIRECTIONS
Too few directions to create a field : must be at least 3

PDB_UNDEFINED_STATE_ID
For multi propagation purposes, the input satId is not part of the initial states map

PDB_UNSUPPORTED_ARRAY_DIMENSION
unsupported parameter

PDB_UNSUPPORTED_DEGREE_FOR_PARTIAL_DERIVATIVES
Unsopported degree for Stela force model partial derivatives computation.

PDB_UNSUPPORTED_DEGREE_FOR_PERTURBATIONS
Unsopported degree for Stela force model perturbations computation.

PDB_UNSUPPORTED_DEGREE_FOR_SHORT_PERIODS
Unsopported degree for Stela force model short periods computation.

PDB_UNSUPPORTED_OPERATION
Error message for radiative model: methods do not have sense.

PDB_UNSUPPORTED_PARAMETER_1
unsupported parameter

PDB_UNSUPPORTED_PARAMETER_1_2_3
unsupported parameter

PDB_UNSUPPORTED_PARAMETER_5
unsupported parameter

PDB_USK_FILE_ERROR
USK file error.

PDB_VALUE_SHOULD_BE_POSITIVE
This input value should be positive

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

Method Summary

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

PDB_FOO_MESSAGE

public static final PatriusMessages PDB_FOO_MESSAGE

A foo message for testing purpose.

PDB_INVALID_ANGLE_INTERVAL

public static final PatriusMessages PDB_INVALID_ANGLE_INTERVAL

Invalid angle interval message.

PDB_ANGLE_OUTSIDE_INTERVAL

public static final PatriusMessages PDB_ANGLE_OUTSIDE_INTERVAL

Angle outside interval message.

PDB_ZERO_NORM

public static final PatriusMessages PDB_ZERO_NORM

The vector's norm can't be zero.

PDB_NO_MAIN_PART

public static final PatriusMessages PDB_NO_MAIN_PART

No main Part.

PDB_ALREADY_A_MAIN_PART

public static final PatriusMessages PDB_ALREADY_A_MAIN_PART

Already a main Part.

PDB_PART_NAME_EXISTS

public static final PatriusMessages PDB_PART_NAME_EXISTS

A part with this name already exists.

PDB_PART_DONT_EXIST

public static final PatriusMessages PDB_PART_DONT_EXIST

No part with this name.

PDB_MAIN_FRAME_HAS_NO_PARENT

public static final PatriusMessages PDB_MAIN_FRAME_HAS_NO_PARENT

The main part's frame must have a parent.

PDB_BAD_PARENT_FRAME

public static final PatriusMessages PDB_BAD_PARENT_FRAME

The main part's frame must be the same as the SpacecraftState's definition frame.

PDB_PROPERTY_ALREADY_EXIST

public static final PatriusMessages PDB_PROPERTY_ALREADY_EXIST

A property of this type already exists in this part.

PDB_BAD_LENGTH

public static final PatriusMessages PDB_BAD_LENGTH

Bad input length

PDB_VALUE_SHOULD_BE_POSITIVE

public static final PatriusMessages PDB_VALUE_SHOULD_BE_POSITIVE

This input value should be positive

PDB_NO_RADIATIVE_MASS_PROPERTIES

public static final PatriusMessages PDB_NO_RADIATIVE_MASS_PROPERTIES

Error message for radiative model: no required radiative properties

PDB_NO_AERO_MASS_PROPERTIES

public static final PatriusMessages PDB_NO_AERO_MASS_PROPERTIES

Error message for aero model: no required aero properties

PDB_NO_AERO_GLOBAL_MASS_PROPERTIES

public static final PatriusMessages PDB_NO_AERO_GLOBAL_MASS_PROPERTIES

Error message for aero drag and lift model: no required aero properties

PDB_NO_GEOMETRY_PROPERTY

public static final PatriusMessages PDB_NO_GEOMETRY_PROPERTY

Error message for masking computations : no required geometry property

PDB_NO_RF_PROPERTY

public static final PatriusMessages PDB_NO_RF_PROPERTY

Error message for RF link budget model : no required RF property

PDB_NO_SENSOR_PROPERTY

public static final PatriusMessages PDB_NO_SENSOR_PROPERTY

Error message for extrema sight axis detector using an assembly and a part name : no required SENSOR property

PDB_REDUNDANT_RADIATIVE_PROPERTIES

public static final PatriusMessages PDB_REDUNDANT_RADIATIVE_PROPERTIES

Error message for radiative model: redundant radiative properties

PDB_REDUNDANT_AERO_PROPERTIES

public static final PatriusMessages PDB_REDUNDANT_AERO_PROPERTIES

Error message for aero model: redundant aero properties

PDB_UNSUPPORTED_OPERATION

public static final PatriusMessages PDB_UNSUPPORTED_OPERATION

Error message for radiative model: methods do not have sense.

PDB_NOT_IMPLEMENTED

public static final PatriusMessages PDB_NOT_IMPLEMENTED

Error message for not supported method

PDB_TOO_FEW_DIRECTIONS

public static final PatriusMessages PDB_TOO_FEW_DIRECTIONS

Too few directions to create a field : must be at least 3

PDB_CLOSE_CONSECUTIVE_DIRECTIONS

public static final PatriusMessages PDB_CLOSE_CONSECUTIVE_DIRECTIONS

Two consecutive directions are too close to create the zone

PDB_CROSSING_ARCS

public static final PatriusMessages PDB_CROSSING_ARCS

Two consecutive directions are too close to create the zone

PDB_INVALID_DATE

public static final PatriusMessages PDB_INVALID_DATE

Invalid date specified.

PDB_NOT_INERTIAL_FRAME

public static final PatriusMessages PDB_NOT_INERTIAL_FRAME

The frame must be pseudo inertial.

PDB_NULL_TEMPERATURE

public static final PatriusMessages PDB_NULL_TEMPERATURE

The absolute temperature can't be zero or lower

PDB_INVALID_VECTORS_FOR_SECTOR_FIELD

public static final PatriusMessages PDB_INVALID_VECTORS_FOR_SECTOR_FIELD

Invalid vectors for sector field of view creation.

PDB_UNSUPPORTED_PARAMETER_1_2_3

public static final PatriusMessages PDB_UNSUPPORTED_PARAMETER_1_2_3

unsupported parameter

PDB_UNSUPPORTED_PARAMETER_5

public static final PatriusMessages PDB_UNSUPPORTED_PARAMETER_5

unsupported parameter

PDB_UNSUPPORTED_PARAMETER_1

public static final PatriusMessages PDB_UNSUPPORTED_PARAMETER_1

unsupported parameter

PDB_UNSUPPORTED_ARRAY_DIMENSION

public static final PatriusMessages PDB_UNSUPPORTED_ARRAY_DIMENSION

unsupported parameter

PDB_IONO_DATE_OUT_OF_FILE

public static final PatriusMessages PDB_IONO_DATE_OUT_OF_FILE

iono invalid date.

PDB_USK_FILE_ERROR

public static final PatriusMessages PDB_USK_FILE_ERROR

USK file error.

PDB_OSC_MEAN_CVG_ERROR

public static final PatriusMessages PDB_OSC_MEAN_CVG_ERROR

Osculating to mean conversion convergence error.

PDB_UNSUPPORTED_DEGREE_FOR_PERTURBATIONS

public static final PatriusMessages PDB_UNSUPPORTED_DEGREE_FOR_PERTURBATIONS

Unsopported degree for Stela force model perturbations computation.

PDB_UNSUPPORTED_DEGREE_FOR_PARTIAL_DERIVATIVES

public static final PatriusMessages PDB_UNSUPPORTED_DEGREE_FOR_PARTIAL_DERIVATIVES

Unsopported degree for Stela force model partial derivatives computation.

PDB_UNSUPPORTED_DEGREE_FOR_SHORT_PERIODS

public static final PatriusMessages PDB_UNSUPPORTED_DEGREE_FOR_SHORT_PERIODS

Unsopported degree for Stela force model short periods computation.

PDB_GEODETIC_PARAMETERS_COMPUTATION_FAILED

public static final PatriusMessages PDB_GEODETIC_PARAMETERS_COMPUTATION_FAILED

The geodetic altitude and latitude computation failed.

PDB_SIMPSON_RULE_FAILED

public static final PatriusMessages PDB_SIMPSON_RULE_FAILED

The Simpson rule computation failed.

PDB_SQUARING_FAILED

public static final PatriusMessages PDB_SQUARING_FAILED

The squaring computation failed.

PDB_PROPAGATION_NO_REENTRY

public static final PatriusMessages PDB_PROPAGATION_NO_REENTRY

For Stela purposes, reentry did not occur after n steps

PDB_MULTI_SAT_DATE_MISMATCH

public static final PatriusMessages PDB_MULTI_SAT_DATE_MISMATCH

For multi propagation purposes, added states date is different from others states date

PDB_UNDEFINED_STATE_ID

public static final PatriusMessages PDB_UNDEFINED_STATE_ID

For multi propagation purposes, the input satId is not part of the initial states map

PDB_NULL_STATE_ID

public static final PatriusMessages PDB_NULL_STATE_ID

For multi propagation purposes, the input sat Id is null or empty

PDB_SAT_ID_ALREADY_USED

public static final PatriusMessages PDB_SAT_ID_ALREADY_USED

For multi propagation purposes, the user try to add a state with a name already added

PDB_ORBIT_TOLERENCE_LENGTH

public static final PatriusMessages PDB_ORBIT_TOLERENCE_LENGTH

For multi propagation purposes, the added tolerance is not of dimension-6

PDB_NORTHING_OUT_OF_RANGE

public static final PatriusMessages PDB_NORTHING_OUT_OF_RANGE

northing value out of range

PDB_EASTING_OUT_OF_RANGE

public static final PatriusMessages PDB_EASTING_OUT_OF_RANGE

easting value out of range

PDB_POINTS_TOO_CLOSE

public static final PatriusMessages PDB_POINTS_TOO_CLOSE

points too close, cannot define azimuth.

PDB_LATITUDE_CLOSE_90

public static final PatriusMessages PDB_LATITUDE_CLOSE_90

the latitude is close or over -/+ 90°.

PDB_LATITUDE_OUT_OF_RANGE

public static final PatriusMessages PDB_LATITUDE_OUT_OF_RANGE

the latitude is out of range

Method Detail

values

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

Returns:

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

valueOf

public static PatriusMessages 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.