1   /* Copyright 2002-2021 CS GROUP
2    * Licensed to CS GROUP (CS) under one or more
3    * contributor license agreements.  See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * CS licenses this file to You under the Apache License, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * the License.  You may obtain a copy of the License at
8    *
9    *   http://www.apache.org/licenses/LICENSE-2.0
10   *
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the License for the specific language governing permissions and
15   * limitations under the License.
16   */
17  package org.orekit.errors;
18  
19  import java.io.IOException;
20  import java.io.InputStream;
21  import java.io.InputStreamReader;
22  import java.net.URL;
23  import java.net.URLConnection;
24  import java.nio.charset.StandardCharsets;
25  import java.util.Locale;
26  import java.util.MissingResourceException;
27  import java.util.PropertyResourceBundle;
28  import java.util.ResourceBundle;
29  
30  import org.hipparchus.exception.Localizable;
31  
32  /**
33   * Enumeration for localized messages formats.
34   * <p>
35   * The constants in this enumeration represent the available formats as
36   * localized strings. These formats are intended to be localized using simple
37   * properties files, using the constant name as the key and the property value
38   * as the message format. The source English format is provided in the constants
39   * themselves to serve both as a reminder for developers to understand the
40   * parameters needed by each format, as a basis for translators to create
41   * localized properties files, and as a default format if some translation is
42   * missing.
43   * </p>
44   * @since 2.1
45   */
46  public enum OrekitMessages implements Localizable {
47  
48      // CHECKSTYLE: stop JavadocVariable check
49  
50      INTERNAL_ERROR("internal error, please notify development team by creating a new topic at {0}"),
51      ALTITUDE_BELOW_ALLOWED_THRESHOLD("altitude ({0} m) is below the {1} m allowed threshold"),
52      POINT_INSIDE_ELLIPSOID("point is inside ellipsoid"),
53      TRAJECTORY_INSIDE_BRILLOUIN_SPHERE("trajectory inside the Brillouin sphere (r = {0})"),
54      ALMOST_EQUATORIAL_ORBIT("almost equatorial orbit (i = {0} degrees)"),
55      ALMOST_CRITICALLY_INCLINED_ORBIT("almost critically inclined orbit (i = {0} degrees)"),
56      UNABLE_TO_COMPUTE_ECKSTEIN_HECHLER_MEAN_PARAMETERS(
57              "unable to compute Eckstein-Hechler mean parameters after {0} iterations"),
58      UNABLE_TO_COMPUTE_TLE(
59                      "unable to compute TLE after {0} iterations"),
60      NULL_PARENT_FOR_FRAME("null parent for frame {0}"),
61      FRAME_ALREADY_ATTACHED("frame {0} is already attached to frame {1}"),
62      FRAME_NOT_ATTACHED("frame {0} is not attached to the main frames tree"),
63      FRAME_ANCESTOR_OF_BOTH_FRAMES("frame {0} is an ancestor of both frames {1} and {2}"),
64      FRAME_ANCESTOR_OF_NEITHER_FRAME("frame {0} is an ancestor of neither frame {1} nor {2}"),
65      FRAME_NO_NTH_ANCESTOR("frame {0} has depth {1}, it cannot have an ancestor {2} levels above"),
66      NO_SUCH_ITRF_FRAME("ITRF frame {0} not found"),
67      UNSUPPORTED_LOCAL_ORBITAL_FRAME("unsupported local orbital frame {0}"),
68      NON_PSEUDO_INERTIAL_FRAME("non pseudo-inertial frame \"{0}\""),
69      DATA_ROOT_DIRECTORY_DOES_NOT_EXIST("data root directory {0} does not exist"),
70      NOT_A_DIRECTORY("{0} is not a directory"),
71      NEITHER_DIRECTORY_NOR_ZIP_OR_JAR("{0} is neither a directory nor a zip/jar archive file"),
72      UNABLE_TO_FIND_RESOURCE("unable to find resource {0} in classpath"),
73      NO_EARTH_ORIENTATION_PARAMETERS_LOADED("no Earth Orientation Parameters loaded"),
74      MISSING_EARTH_ORIENTATION_PARAMETERS_BETWEEN_DATES("missing Earth Orientation Parameters between {0} and {1}"),
75      MISSING_EARTH_ORIENTATION_PARAMETERS_BETWEEN_DATES_GAP("missing Earth Orientation Parameters between {0} and {1}, gap is {2,number,0.0##############E0} s"),
76      NO_EARTH_ORIENTATION_PARAMETERS("missing Earth Orientation Parameters"),
77      NOT_A_SUPPORTED_IERS_DATA_FILE("file {0} is not a supported IERS data file"),
78      INCONSISTENT_DATES_IN_IERS_FILE("inconsistent dates in IERS file {0}: {1}-{2}-{3} and MJD {4}"),
79      UNEXPECTED_DATA_AFTER_LINE_IN_FILE("unexpected data after line {0} in file {1}: {2}"),
80      UNEXPECTED_DATA_AT_LINE_IN_FILE("unexpected data at line {0} in file {1}"),
81      NON_CHRONOLOGICAL_DATES_IN_FILE("non-chronological dates in file {0}, line {1}"),
82      NO_IERS_UTC_TAI_HISTORY_DATA_LOADED("no IERS UTC-TAI history data loaded"),
83      NO_ENTRIES_IN_IERS_UTC_TAI_HISTORY_FILE("no entries found in IERS UTC-TAI history file {0}"),
84      MISSING_SERIE_J_IN_FILE("missing serie j = {0} in file {1} (line {2})"),
85      CANNOT_PARSE_BOTH_TAU_AND_GAMMA("cannot parse both τ and γ from the same Poissons series file"),
86      UNEXPECTED_END_OF_FILE_AFTER_LINE("unexpected end of file {0} (after line {1})"),
87      UNABLE_TO_PARSE_LINE_IN_FILE("unable to parse line {0} of file {1}:\n{2}"),
88      UNABLE_TO_PARSE_ELEMENT_IN_FILE("unable to parse element {0} at line {1}, file {2}"),
89      UNABLE_TO_FIND_FILE("unable to find file {0}"),
90      SPACECRAFT_MASS_BECOMES_NEGATIVE("spacecraft mass becomes negative: {0} kg"),
91      POSITIVE_FLOW_RATE("positive flow rate (q: {0})"),
92      NO_GRAVITY_FIELD_DATA_LOADED("no gravity field data loaded"),
93      GRAVITY_FIELD_NORMALIZATION_UNDERFLOW("gravity field normalization underflow for degree {0} and order {1}"),
94      NO_OCEAN_TIDE_DATA_LOADED("no ocean tide data loaded"),
95      OCEAN_TIDE_DATA_DEGREE_ORDER_LIMITS("ocean tide data file {0} limited to degree {1} and order {2}"),
96      OCEAN_TIDE_LOAD_DEFORMATION_LIMITS(
97              "load deformation coefficients limited to degree {0}, cannot parse degree {1} term from file {2}"),
98      POLAR_TRAJECTORY("polar trajectory (distance to polar axis: {0})"),
99      UNEXPECTED_FILE_FORMAT_ERROR_FOR_LOADER("unexpected format error for file {0} with loader {1}"),
100     DUPLICATED_GRAVITY_FIELD_COEFFICIENT_IN_FILE("duplicated gravity field coefficient {0}({1}, {2}) in file {3}"),
101     MISSING_GRAVITY_FIELD_COEFFICIENT_IN_FILE("missing gravity field coefficient {0}({1}, {2}) in file {3}"),
102     TOO_LARGE_DEGREE_FOR_GRAVITY_FIELD("too large degree (n = {0}, potential maximal degree is {1})"),
103     TOO_LARGE_ORDER_FOR_GRAVITY_FIELD("too large order (m = {0}, potential maximal order is {1})"),
104     SEVERAL_REFERENCE_DATES_IN_GRAVITY_FIELD("several reference dates ({0} and {1} differ by {3,number,0.0##############E0} s) found in gravity field file {2}"),
105     NO_TLE_FOR_OBJECT("no TLE data available for object {0}"),
106     NO_TLE_FOR_LAUNCH_YEAR_NUMBER_PIECE(
107             "no TLE data available for launch year {0}, launch number {1}, launch piece {2}"),
108     NOT_TLE_LINES("lines {0} and {1} are not TLE lines:\n{0}: \"{2}\"\n{1}: \"{3}\""),
109     MISSING_SECOND_TLE_LINE("expected a second TLE line after line {0}:\n{0}: \"{1}\""),
110     TLE_LINES_DO_NOT_REFER_TO_SAME_OBJECT("TLE lines do not refer to the same object:\n{0}\n{1}"),
111     TLE_INVALID_PARAMETER("invalid TLE parameter for object {0}: {1} = {2}"),
112     TLE_CHECKSUM_ERROR("wrong checksum of TLE line {0}, expected {1} but got {2} ({3})"),
113     NO_TLE_DATA_AVAILABLE("no TLE data available"),
114     NOT_POSITIVE_SPACECRAFT_MASS("spacecraft mass is not positive: {0} kg"),
115     TOO_LARGE_ECCENTRICITY_FOR_PROPAGATION_MODEL("too large eccentricity for propagation model: e = {0}"),
116     NO_SOLAR_ACTIVITY_AT_DATE("no solar activity available at {0}, data available only in range [{1}, {2}]"),
117     NON_EXISTENT_MONTH("non-existent month {0}"),
118     NON_EXISTENT_YEAR_MONTH_DAY("non-existent date {0}-{1}-{2}"),
119     NON_EXISTENT_WEEK_DATE("non-existent week date {0}-W{1}-{2}"),
120     NON_EXISTENT_DATE("non-existent date {0}"),
121     NON_EXISTENT_DAY_NUMBER_IN_YEAR("no day number {0} in year {1}"),
122     NON_EXISTENT_HMS_TIME("non-existent time {0}:{1}:{2}"),
123     NON_EXISTENT_TIME("non-existent time {0}"),
124     OUT_OF_RANGE_SECONDS_NUMBER("out of range seconds number: {0}"),
125     OUT_OF_RANGE_SECONDS_NUMBER_DETAIL("out of range seconds number: {0} is not in [{1}, {2}]"),
126     ANGLE_TYPE_NOT_SUPPORTED("angle type not supported, supported angles: {0}, {1} and {2}"),
127     SATELLITE_COLLIDED_WITH_TARGET("satellite collided with target"),
128     ATTITUDE_POINTING_LAW_DOES_NOT_POINT_TO_GROUND("attitude pointing law misses ground"),
129     TOO_SHORT_TRANSITION_TIME_FOR_ATTITUDES_SWITCH(
130             "{0} seconds transition time for attitudes switch is too short, should be longer than {1} seconds"),
131     ORBIT_AND_ATTITUDE_DATES_MISMATCH("orbit date ({0}) does not match attitude date ({1})"),
132     FRAMES_MISMATCH("frame {0} does not match frame {1}"),
133     INITIAL_STATE_NOT_SPECIFIED_FOR_ORBIT_PROPAGATION("initial state not specified for orbit propagation"),
134     EVENT_DATE_TOO_CLOSE(
135             "target event date must be before {1} by {3,number,0.0##############E0} seconds or after {2} by {3,number,0.0##############E0} seconds, but target event date {0} is {4,number,0.0##############E0} seconds before {1} and {5,number,0.0##############E0} seconds after {2} so it cannot be added"),
136     UNABLE_TO_READ_JPL_HEADER("unable to read header record from JPL ephemerides binary file {0}"),
137     INCONSISTENT_ASTRONOMICAL_UNIT_IN_FILES(
138             "inconsistent values of astronomical unit in JPL ephemerides files: ({0} and {1})"),
139     INCONSISTENT_EARTH_MOON_RATIO_IN_FILES(
140             "inconsistent values of Earth/Moon mass ratio in JPL ephemerides files: ({0} and {1})"),
141     NO_DATA_LOADED_FOR_CELESTIAL_BODY("no data loaded for celestial body {0}"),
142     NOT_A_JPL_EPHEMERIDES_BINARY_FILE("file {0} is not a JPL ephemerides binary file"),
143     NOT_A_MARSHALL_SOLAR_ACTIVITY_FUTURE_ESTIMATION_FILE(
144             "file {0} is not a Marshall Solar Activity Future Estimation (MSAFE) file"),
145     NO_JPL_EPHEMERIDES_BINARY_FILES_FOUND("no JPL ephemerides binary files found"),
146     OUT_OF_RANGE_BODY_EPHEMERIDES_DATE("out of range date for {0} ephemerides: {1}"),
147     OUT_OF_RANGE_EPHEMERIDES_DATE("out of range date for ephemerides: {0}, [{1}, {2}]"),
148     OUT_OF_RANGE_EPHEMERIDES_DATE_BEFORE("out of range date for ephemerides: {0} is {3,number,0.0##############E0} s before [{1}, {2}]"),
149     OUT_OF_RANGE_EPHEMERIDES_DATE_AFTER("out of range date for ephemerides: {0} is {3,number,0.0##############E0} s after [{1}, {2}]"),
150     UNEXPECTED_TWO_ELEVATION_VALUES_FOR_ONE_AZIMUTH(
151             "unexpected two elevation values: {0} and {1}, for one azimuth: {2}"),
152     UNSUPPORTED_PARAMETER_NAME("unsupported parameter name {0}, supported names: {1}"),
153     TOO_SMALL_SCALE_FOR_PARAMETER("scale factor for parameter {0} is too small: {1}"),
154     UNKNOWN_ADDITIONAL_STATE("unknown additional state \"{0}\""),
155     UNKNOWN_MONTH("unknown month \"{0}\""),
156     SINGULAR_JACOBIAN_FOR_ORBIT_TYPE("Jacobian matrix for type {0} is singular with current orbit"),
157     STATE_JACOBIAN_NOT_INITIALIZED("state Jacobian has not been initialized yet"),
158     STATE_JACOBIAN_NOT_6X6("state Jacobian is a {0}x{1} matrix, it should be a 6x6 matrix"),
159     STATE_AND_PARAMETERS_JACOBIANS_ROWS_MISMATCH("state Jacobian has {0} rows but parameters Jacobian has {1} rows"),
160     INITIAL_MATRIX_AND_PARAMETERS_NUMBER_MISMATCH(
161             "initial Jacobian matrix has {0} columns, but {1} parameters have been selected"),
162     ORBIT_A_E_MISMATCH_WITH_CONIC_TYPE(
163             "orbit should be either elliptic with a > 0 and e < 1 or hyperbolic with a < 0 and e > 1, a = {0}, e = {1}"),
164     ORBIT_ANOMALY_OUT_OF_HYPERBOLIC_RANGE("true anomaly {0} out of hyperbolic range (e = {1}, {2} < v < {3})"),
165     HYPERBOLIC_ORBIT_NOT_HANDLED_AS("hyperbolic orbits cannot be handled as {0} instances"),
166     CCSDS_DATE_INVALID_PREAMBLE_FIELD("invalid preamble field in CCSDS date: {0}"),
167     CCSDS_DATE_INVALID_LENGTH_TIME_FIELD("invalid time field length in CCSDS date: {0}, expected {1}"),
168     CCSDS_DATE_MISSING_AGENCY_EPOCH("missing agency epoch in CCSDS date"),
169     CCSDS_MISSING_KEYWORD("missing mandatory key {0} in CCSDS file {1}"),
170     CCSDS_KEYWORD_NOT_ALLOWED_IN_VERSION("key {0} is not allowed in format version {1}"),
171     CCSDS_UNEXPECTED_KEYWORD("unexpected keyword in CCSDS line number {0} of file {1}:\n{2}"),
172     CCSDS_UNKNOWN_GM("the central body gravitational coefficient cannot be retrieved from the ODM"),
173     CCSDS_UNKNOWN_SPACECRAFT_MASS("there is no spacecraft mass associated with this ODM file"),
174     CCSDS_UNKNOWN_CONVENTIONS("no IERS conventions have been set before parsing"),
175     CCSDS_INVALID_FRAME("frame {0} is not valid in this CCSDS file context"),
176     CCSDS_INCONSISTENT_TIME_SYSTEMS("inconsistent time systems: {0} ≠ {1}"),
177     CCSDS_TIME_SYSTEM_NOT_IMPLEMENTED(
178             "use of time system {0} in CCSDS files requires an additional ICD and is not implemented in Orekit"),
179     CCSDS_TDM_KEYWORD_NOT_FOUND("No CCSDS TDM keyword was found at line {0} of file {1}:\n{2}"),
180     CCSDS_TDM_MISSING_RANGE_UNITS_CONVERTER("no Range Units converter configured for parsing Tracking Data Message"),
181     CCSDS_TIME_SYSTEM_NOT_READ_YET("Time system should have already been set before line {0} of file {1}"),
182     CCSDS_AEM_INCONSISTENT_TIME_SYSTEMS("inconsistent time systems in the attitude blocks: {0} ≠ {1}"),
183     CCSDS_AEM_ATTITUDE_TYPE_NOT_IMPLEMENTED("attitude type {0} in CCSDS AEM files is not implemented in Orekit"),
184     CCSDS_INVALID_ROTATION_SEQUENCE("invalid rotation sequence {0} at line {1} of file {2}"),
185     CCSDS_UNSUPPORTED_ELEMENT_SET_TYPE("element set type {0} ({1}) is not supported yet"),
186     CCSDS_UNSUPPORTED_RETROGRADE_EQUINOCTIAL("retrograde factor not supported in element set {0}"),
187     CCSDS_ELEMENT_SET_WRONG_NB_COMPONENTS("element set type {0} ({1}) expects {2} elements"),
188     CCSDS_MANEUVER_UNITS_WRONG_NB_COMPONENTS("wrong number of units for maneuver {0}"),
189     CCSDS_MANEUVER_MISSING_TIME("missing time field for maneuver {0}"),
190     ADDITIONAL_STATE_NAME_ALREADY_IN_USE("name \"{0}\" is already used for an additional state"),
191     NON_RESETABLE_STATE("reset state not allowed"),
192     DSST_NEWCOMB_OPERATORS_COMPUTATION("Cannot compute Newcomb operators for sigma > rho ({0} > {1})"),
193     DSST_VMNS_COEFFICIENT_ERROR_MS("Cannot compute the Vmns coefficient with m > n ({0} > {1})"),
194     DSST_SPR_SHADOW_INCONSISTENT("inconsistent shadow computation: entry = {0} whereas exit = {1}"),
195     DSST_ECC_NO_NUMERICAL_AVERAGING_METHOD(
196             "The current orbit has an eccentricity ({0} > 0.5). DSST needs an unimplemented time dependent numerical method to compute the averaged rates"),
197     SP3_UNSUPPORTED_VERSION("unsupported sp3 file version {0}"),
198     SP3_NUMBER_OF_EPOCH_MISMATCH("found {0} epochs in file {1}, expected {2}"),
199     SP3_UNEXPECTED_END_OF_FILE("unexpected end of sp3 file (after line {0})"),
200     CLOCK_FILE_UNSUPPORTED_VERSION("unsupported clock file version {0}"),
201     NAVIGATION_FILE_UNSUPPORTED_VERSION("unsupported navigation messages file version {0}"),
202     NON_EXISTENT_GEOMAGNETIC_MODEL("non-existent geomagnetic model {0} for year {1}"),
203     UNSUPPORTED_TIME_TRANSFORM(
204             "geomagnetic model {0} with epoch {1} does not support time transformation, no secular variation coefficients defined"),
205     OUT_OF_RANGE_TIME_TRANSFORM(
206             "time transformation of geomagnetic model {0} with epoch {1} is outside its validity range: {2} != [{3}, {4}]"),
207     NOT_ENOUGH_DATA_FOR_INTERPOLATION("not enough data for interpolation (sample size = {0})"),
208     NOT_ENOUGH_CACHED_NEIGHBORS("too small number of cached neighbors: {0} (must be at least {1})"),
209     NO_CACHED_ENTRIES("no cached entries"),
210     NON_CHRONOLOGICALLY_SORTED_ENTRIES("generated entries not sorted: {0} > {1} by {2,number,0.0##############E0} s"),
211     NO_DATA_GENERATED("no data generated around date: {0}"),
212     UNABLE_TO_GENERATE_NEW_DATA_BEFORE("unable to generate new data before {0}, but data is requested for {1} which is {2,number,0.0##############E0} s before"),
213     UNABLE_TO_GENERATE_NEW_DATA_AFTER("unable to generate new data after {0}, but data is requested for {1} which is {2,number,0.0##############E0} s after"),
214     UNABLE_TO_COMPUTE_HYPERBOLIC_ECCENTRIC_ANOMALY(
215             "unable to compute hyperbolic eccentric anomaly from the mean anomaly after {0} iterations"),
216     UNABLE_TO_COMPUTE_DSST_MEAN_PARAMETERS("unable to compute mean orbit from osculating orbit after {0} iterations"),
217     OUT_OF_RANGE_DERIVATION_ORDER("derivation order {0} is out of range"),
218     ORBIT_TYPE_NOT_ALLOWED("orbit type {0} not allowed here, allowed types: {1}"),
219     NON_PSEUDO_INERTIAL_FRAME_NOT_SUITABLE_AS_REFERENCE_FOR_INERTIAL_FORCES(
220             "non pseudo-inertial frame {0} is not suitable as reference for inertial forces"),
221     METHOD_NOT_AVAILABLE_WITHOUT_CENTRAL_BODY("method not available in the absence of a central body"),
222     INCOMPATIBLE_FRAMES("operation not available between frames {0} and {1}"),
223     UNDEFINED_ORBIT("orbit not defined, state rather contains an absolute position-velocity-acceleration"),
224     UNDEFINED_ABSOLUTE_PVCOORDINATES(
225             "absolute position-velocity-acceleration not defined, state rather contains an orbit"),
226     INERTIAL_FORCE_MODEL_MISSING("an inertial force model has to be used when propagating in non-inertial frame {0}"),
227     NO_SEM_ALMANAC_AVAILABLE("no SEM almanac file found"),
228     NOT_A_SUPPORTED_SEM_ALMANAC_FILE("file {0} is not a supported SEM almanac file"),
229     NO_YUMA_ALMANAC_AVAILABLE("no Yuma almanac file found"),
230     NOT_A_SUPPORTED_YUMA_ALMANAC_FILE("file {0} is not a supported Yuma almanac file"),
231     NOT_ENOUGH_GNSS_FOR_DOP("only {0} GNSS orbits are provided while {1} are needed to compute the DOP"),
232     NOT_ENOUGH_PROPAGATORS(
233             "Creating an aggregate propagator requires at least one constituent propagator, but none were provided."),
234     NOT_ENOUGH_ATTITUDE_PROVIDERS(
235                     "Creating an aggregate attitude provider requires at least one constituent attitude provider, but none were provided."),
236     NULL_ARGUMENT("argument {0} cannot be null"),
237     VALUE_NOT_FOUND("value {0} not found in {1}"),
238     KLOBUCHAR_ALPHA_BETA_NOT_LOADED("Klobuchar coefficients α or β could not be loaded from {0}"),
239     KLOBUCHAR_ALPHA_BETA_NOT_AVAILABLE_FOR_DATE("Klobuchar coefficients α or β not available for date {0}"),
240     NO_KLOBUCHAR_ALPHA_BETA_IN_FILE("file {0} does not contain Klobuchar coefficients α or β"),
241     NO_REFERENCE_DATE_FOR_PARAMETER("no reference date set for parameter {0}"),
242     STATION_NOT_FOUND("station {0} not found, known stations: {1}"),
243     UNKNOWN_SATELLITE_SYSTEM("unknown satellite system {0}"),
244     UNKNOWN_TIME_SYSTEM("unknown time system {0}"),
245     UNKNOWN_CLOCK_DATA_TYPE("unknown clock data type {0}"),
246     UNKNOWN_SATELLITE_ANTENNA_CODE("unknown satellite antenna code {0}"),
247     UNSUPPORTED_FREQUENCY_FOR_ANTENNA("frequency {0} is not supported by antenna {1}"),
248     CANNOT_FIND_SATELLITE_IN_SYSTEM("cannot find satellite {0} in satellite system {1}"),
249     UNKNOWN_RINEX_FREQUENCY("unknown RINEX frequency {0} in file {1}, line {2}"),
250     MISMATCHED_FREQUENCIES("mismatched frequencies in file {0}, line {1} (expected {2}, got {3})"),
251     WRONG_COLUMNS_NUMBER("wrong number of columns in file {0}, line {1} (expected {2} columns, got {3} columns)"),
252     UNSUPPORTED_FILE_FORMAT("unsupported format for file {0}"),
253     INCOMPLETE_HEADER("incomplete header in file {0}"),
254     INCONSISTENT_NUMBER_OF_SATS(
255             "inconsistent number of satellites in line {0}, file {1}: observation with {2} satellites and number of max satellites is {3}"),
256     INCONSISTENT_SATELLITE_SYSTEM(
257             "the satellite system {3} from line {0}, file {1} is not consistent with the Rinex Satellite System {2} in header"),
258     NO_PROPAGATOR_CONFIGURED("no propagator configured"),
259     DIMENSION_INCONSISTENT_WITH_PARAMETERS("dimension {0} is inconsistent with parameters list: {1}"),
260     NOT_A_SUPPORTED_UNIX_COMPRESSED_FILE("file {0} is not a supported Unix-compressed file"),
261     UNEXPECTED_END_OF_FILE("unexpected end of file {0}"),
262     CORRUPTED_FILE("file {0} is corrupted"),
263     VIENNA_ACOEF_OR_ZENITH_DELAY_NOT_LOADED("Vienna coefficients ah or aw or zh or zw could not be loaded from {0}"),
264     VIENNA_ACOEF_OR_ZENITH_DELAY_NOT_AVAILABLE_FOR_DATE(
265             "Vienna coefficients ah or aw or zh or zw not available for date {0}"),
266     NO_VIENNA_ACOEF_OR_ZENITH_DELAY_IN_FILE("file {0} does not contain Vienna coefficients ah, aw, zh or zw"),
267     IRREGULAR_OR_INCOMPLETE_GRID("irregular or incomplete grid in file {0}"),
268     INVALID_SATELLITE_SYSTEM("invalid satellite system {0}"),
269     NO_TEC_DATA_IN_FILE_FOR_DATE("IONEX file {0} does not contain TEC data for date {1}"),
270     INCONSISTENT_NUMBER_OF_TEC_MAPS_IN_FILE("number of maps {0} is inconsistent with header specification: {1}"),
271     NO_LATITUDE_LONGITUDE_BONDARIES_IN_IONEX_HEADER(
272             "file {0} does not contain latitude or longitude bondaries in its header section"),
273     NO_EPOCH_IN_IONEX_HEADER("file {0} does not contain epoch of first or last map in its header section"),
274     ITRF_VERSIONS_PREFIX_ONLY("The first column of itrf-versions.conf is a plain " +
275             "prefix that is matched against the name of each loaded file. It should " +
276             "not contain any regular expression syntax or directory components, i.e. " +
277             "\"/\" or \"\\\". Actual value: \"{0}\"."),
278     CANNOT_COMPUTE_AIMING_AT_SINGULAR_POINT(
279             "cannot compute aiming direction at singular point: latitude = {0}, longitude = {1}"),
280     STEC_INTEGRATION_DID_NOT_CONVERGE("STEC integration did not converge"),
281     MODIP_GRID_NOT_LOADED("MODIP grid not be loaded from {0}"),
282     NEQUICK_F2_FM3_NOT_LOADED("NeQuick coefficient f2 or fm3 not be loaded from {0}"),
283     NOT_A_SUPPORTED_HATANAKA_COMPRESSED_FILE("file {0} is not a supported Hatanaka-compressed file"),
284     CANNOT_COMPUTE_LAGRANGIAN("Cannot compute around {0}"),
285     TRAJECTORY_NOT_CROSSING_XZPLANE("The trajectory does not cross XZ Plane, it will not result in a Halo Orbit"),
286     MULTIPLE_SHOOTING_UNDERCONSTRAINED(
287             "The multiple shooting problem is underconstrained : {0} free variables, {1} constraints"),
288     INVALID_MEASUREMENT_TYPES_FOR_COMBINATION_OF_MEASUREMENTS(
289             "invalid measurement types {0} and {1} for the combination of measurements {2}"),
290     INCOMPATIBLE_FREQUENCIES_FOR_COMBINATION_OF_MEASUREMENTS(
291             "frequencies {0} and {1} are incompatibles for the {2} combination"),
292     NON_CHRONOLOGICAL_DATES_FOR_OBSERVATIONS("observations are not in chronological order: {0} is {2,number,0.0##############E0} s after {1}"),
293     EXCEPTIONAL_DATA_CONTEXT(
294             "Use of the ExceptionalDataContext detected. This is typically used to detect developer errors."),
295     NON_DIFFERENT_DATES_FOR_OBSERVATIONS(
296             "Observations must have different dates: {0}, {1} ({3,number,0.0##############E0} s from first observation), and {2} ({4,number,0.0##############E0} s from first observation, {5,number,0.0##############E0} s from second observation)"),
297     NON_COPLANAR_POINTS("observations are not in the same plane"),
298     INVALID_PARAMETER_RANGE("invalid parameter {0}: {1} not in range [{2}, {3}]"),
299     PARAMETER_NOT_SET("The parameter {0} should not be null in {1}"),
300     FUNCTION_NOT_IMPLEMENTED("{0} is not implemented"),
301     INVALID_TYPE_FOR_FUNCTION("Impossible to execute {0} with {1} set to {2}"),
302     NO_DATA_IN_FILE("No data could be parsed from file {0}"),
303     CPF_UNEXPECTED_END_OF_FILE("Unexpected end of CPF file (after line {0})"),
304     UNEXPECTED_FORMAT_FOR_ILRS_FILE("Unexpected file format. Must be {0} but is {1}"),
305     CRD_UNEXPECTED_END_OF_FILE("Unexpected end of CRD file (after line {0})"),
306     INVALID_RANGE_INDICATOR_IN_CRD_FILE("Invalid range indicator {0} in CRD file header"),
307     END_OF_ENCODED_MESSAGE("end of encoded message reached"),
308     TOO_LARGE_DATA_TYPE("too large data type ({0} bits)"),
309     UNKNOWN_ENCODED_MESSAGE_NUMBER("unknown encoded message number {0}"),
310     UNKNOWN_AUTHENTICATION_METHOD("unknown authentication method: {0}"),
311     UNKNOWN_CARRIER_PHASE_CODE("unknown carrier phase code: {0}"),
312     UNKNOWN_DATA_FORMAT("unknown data format: {0}"),
313     UNKNOWN_NAVIGATION_SYSTEM("unknown navigation system: {0}"),
314     STREAM_REQUIRES_NMEA_FIX("data stream {0} requires a NMEA fix data"),
315     FAILED_AUTHENTICATION("failed authentication for mountpoint {0}"),
316     CONNECTION_ERROR("error connecting to {0}: {1}"),
317     UNEXPECTED_CONTENT_TYPE("unexpected content type {0}"),
318     CANNOT_PARSE_GNSS_DATA("cannot parse GNSS data from {0}"),
319     UNKNOWN_HOST("unknown host {0}"),
320     SOURCETABLE_PARSE_ERROR("error parsing sourcetable line {0} from {1}: {2}"),
321     CANNOT_PARSE_SOURCETABLE("cannot parse sourcetable from {0}"),
322     MOUNPOINT_ALREADY_CONNECTED("mount point {0} is already connected"),
323     MISSING_HEADER("missing header from {0}: {1}"),
324     NOT_VALID_INTERNATIONAL_DESIGNATOR("{0} is not a valid international designator"),
325     UNINITIALIZED_VALUE_FOR_KEY("value for key {0} has not been initialized"),
326     UNKNOWN_UNIT("unknown unit {0}"),
327     INCOMPATIBLE_UNITS("units {0} and {1} are not compatible"),
328     MISSING_VELOCITY("missing velocity data"),
329     ATTEMPT_TO_GENERATE_MALFORMED_FILE("attempt to generate file {0} with a formatting error"),
330     FIND_ROOT("{0} failed to find root between {1} (g={2,number,0.0##############E0}) and {3} (g={4,number,0.0##############E0})\nLast iteration at {5} (g={6,number,0.0##############E0})");
331 
332     // CHECKSTYLE: resume JavadocVariable check
333 
334     /** Base name of the resource bundle in classpath. */
335     private static final String RESOURCE_BASE_NAME = "assets/org/orekit/localization/OrekitMessages";
336 
337     /** Source English format. */
338     private final String sourceFormat;
339 
340     /**
341      * Simple constructor.
342      * @param sourceFormat source English format to use when no localized version is
343      *                     available
344      */
345     OrekitMessages(final String sourceFormat) {
346         this.sourceFormat = sourceFormat;
347     }
348 
349     /** {@inheritDoc} */
350     public String getSourceString() {
351         return sourceFormat;
352     }
353 
354     /** {@inheritDoc} */
355     public String getLocalizedString(final Locale locale) {
356         try {
357             final ResourceBundle bundle = ResourceBundle.getBundle(RESOURCE_BASE_NAME, locale, new UTF8Control());
358             if (bundle.getLocale().getLanguage().equals(locale.getLanguage())) {
359                 final String translated = bundle.getString(name());
360                 if (translated != null && translated.length() > 0 &&
361                         !translated.toLowerCase().contains("missing translation")) {
362                     // the value of the resource is the translated format
363                     return translated;
364                 }
365             }
366 
367         } catch (MissingResourceException mre) {
368             // do nothing here
369         }
370 
371         // either the locale is not supported or the resource is not translated or
372         // it is unknown: don't translate and fall back to using the source format
373         return sourceFormat;
374 
375     }
376 
377     /**
378      * Control class loading properties in UTF-8 encoding.
379      * <p>
380      * This class has been very slightly adapted from BalusC answer to question:
381      * <a href=
382      * "http://stackoverflow.com/questions/4659929/how-to-use-utf-8-in-resource-properties-with-resourcebundle">
383      * How to use UTF-8 in resource properties with ResourceBundle</a>.
384      * </p>
385      * @since 6.0
386      */
387     public static class UTF8Control extends ResourceBundle.Control {
388 
389         /** {@inheritDoc} */
390         @Override
391         public ResourceBundle newBundle(final String baseName, final Locale locale, final String format,
392                 final ClassLoader loader, final boolean reload)
393                 throws IllegalAccessException, InstantiationException, IOException {
394             // The below is a copy of the default implementation.
395             final String bundleName = toBundleName(baseName, locale);
396             final String resourceName = toResourceName(bundleName, "utf8");
397             ResourceBundle bundle = null;
398             InputStream stream = null;
399             if (reload) {
400                 final URL url = loader.getResource(resourceName);
401                 if (url != null) {
402                     final URLConnection connection = url.openConnection();
403                     if (connection != null) {
404                         connection.setUseCaches(false);
405                         stream = connection.getInputStream();
406                     }
407                 }
408             } else {
409                 stream = loader.getResourceAsStream(resourceName);
410             }
411             if (stream != null) {
412                 try (InputStreamReader inputStreamReader = new InputStreamReader(stream, StandardCharsets.UTF_8)) {
413                     // Only this line is changed to make it to read properties files as UTF-8.
414                     bundle = new PropertyResourceBundle(inputStreamReader);
415                 }
416             }
417             return bundle;
418         }
419     }
420 }