From 25750338d22aa9a4da15b71ee58dd8c64794fa64 Mon Sep 17 00:00:00 2001
From: Luc Maisonobe <luc@orekit.org>
Date: Tue, 22 Apr 2014 17:08:04 +0200
Subject: [PATCH] Moved enumerates out of Rugged top level interface.
---
.../org/orekit/rugged/api/AlgorithmId.java | 50 +++++++++++
.../rugged/api/BodyRotatingFrameId.java | 34 ++++++++
.../org/orekit/rugged/api/EllipsoidId.java | 37 ++++++++
.../orekit/rugged/api/InertialFrameId.java | 40 +++++++++
.../java/org/orekit/rugged/api/Rugged.java | 85 +------------------
.../org/orekit/rugged/core/RuggedImpl.java | 24 +++---
.../orekit/rugged/core/RuggedImplTest.java | 28 +++---
7 files changed, 193 insertions(+), 105 deletions(-)
create mode 100644 src/main/java/org/orekit/rugged/api/AlgorithmId.java
create mode 100644 src/main/java/org/orekit/rugged/api/BodyRotatingFrameId.java
create mode 100644 src/main/java/org/orekit/rugged/api/EllipsoidId.java
create mode 100644 src/main/java/org/orekit/rugged/api/InertialFrameId.java
diff --git a/src/main/java/org/orekit/rugged/api/AlgorithmId.java b/src/main/java/org/orekit/rugged/api/AlgorithmId.java
new file mode 100644
index 00000000..a689d4de
--- /dev/null
+++ b/src/main/java/org/orekit/rugged/api/AlgorithmId.java
@@ -0,0 +1,50 @@
+/* Copyright 2013-2014 CS Systèmes d'Information
+ * Licensed to CS Systèmes d'Information (CS) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * CS licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.orekit.rugged.api;
+
+
+/** Enumerate for Digital Elevation Model intersection.
+ * @author Luc Maisonobe
+ */
+public enum AlgorithmId {
+
+ /** Fast algorithm due to Bernardt Duvenhage.
+ * <p>
+ * The algorithm is described in the 2009 paper:
+ * <a href="http://researchspace.csir.co.za/dspace/bitstream/10204/3041/1/Duvenhage_2009.pdf">Using
+ * An Implicit Min/Max KD-Tree for Doing Efficient Terrain Line of Sight Calculations</a>.
+ * </p>
+ */
+ DUVENHAGE,
+
+ /** Basic, <em>very slow</em> algorithm, designed only for tests and validation purposes.
+ * <p>
+ * The algorithm simply computes entry and exit points at high and low altitudes,
+ * and scans all Digital Elevation Models in the sub-tiles defined by these two
+ * corner points. It is not designed for operational use.
+ * </p>
+ */
+ BASIC_SLOW_EXHAUSTIVE_SCAN_FOR_TESTS_ONLY,
+
+ /** Dummy algorithm that simply ignores the Digital Elevation Model.
+ * <p>
+ * Intersections are computed only with respect to the reference ellipsoid.
+ * </p>
+ */
+ IGNORE_DEM_USE_ELLIPSOID
+
+}
diff --git a/src/main/java/org/orekit/rugged/api/BodyRotatingFrameId.java b/src/main/java/org/orekit/rugged/api/BodyRotatingFrameId.java
new file mode 100644
index 00000000..94be7326
--- /dev/null
+++ b/src/main/java/org/orekit/rugged/api/BodyRotatingFrameId.java
@@ -0,0 +1,34 @@
+/* Copyright 2013-2014 CS Systèmes d'Information
+ * Licensed to CS Systèmes d'Information (CS) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * CS licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.orekit.rugged.api;
+
+
+/** Enumerate for body rotating frames.
+ * @author Luc Maisonobe
+ */
+public enum BodyRotatingFrameId {
+
+ /** Constant for International Terrestrial Reference Frame. */
+ ITRF,
+
+ /** Constant for International Terrestrial Reference Frame based on older equinox paradigm. */
+ ITRF_EQUINOX,
+
+ /** Constant for Geocentric True Of Date frame. */
+ GTOD
+
+}
diff --git a/src/main/java/org/orekit/rugged/api/EllipsoidId.java b/src/main/java/org/orekit/rugged/api/EllipsoidId.java
new file mode 100644
index 00000000..aca2d2ee
--- /dev/null
+++ b/src/main/java/org/orekit/rugged/api/EllipsoidId.java
@@ -0,0 +1,37 @@
+/* Copyright 2013-2014 CS Systèmes d'Information
+ * Licensed to CS Systèmes d'Information (CS) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * CS licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.orekit.rugged.api;
+
+
+/** Enumerate for ellipsoid.
+ * @author Luc Maisonobe
+ */
+public enum EllipsoidId {
+
+ /** Constant for GRS 80 ellipsoid. */
+ GRS80,
+
+ /** Constant for WGS 84 ellipsoid. */
+ WGS84,
+
+ /** Constant for IERS 96 ellipsoid. */
+ IERS96,
+
+ /** Constant for IERS 2003 ellipsoid. */
+ IERS2003
+
+}
diff --git a/src/main/java/org/orekit/rugged/api/InertialFrameId.java b/src/main/java/org/orekit/rugged/api/InertialFrameId.java
new file mode 100644
index 00000000..c88aa029
--- /dev/null
+++ b/src/main/java/org/orekit/rugged/api/InertialFrameId.java
@@ -0,0 +1,40 @@
+/* Copyright 2013-2014 CS Systèmes d'Information
+ * Licensed to CS Systèmes d'Information (CS) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * CS licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.orekit.rugged.api;
+
+
+/** Enumerate for inertial frames.
+ * @author Luc Maisonobe
+ */
+public enum InertialFrameId {
+
+ /** Constant for Geocentric Celestial Reference Frame. */
+ GCRF,
+
+ /** Constant for Earth Mean Equator 2000 frame (aka J2000). */
+ EME2000,
+
+ /** Constant for Mean Of Date frame, with IERS 96 conventions (Lieske precession). */
+ MOD,
+
+ /** Constant for True Of Date frame, with IERS 96 conventions (Wahr nutation). */
+ TOD,
+
+ /** Constant for Veis 1950 frame. */
+ VEIS1950
+
+}
diff --git a/src/main/java/org/orekit/rugged/api/Rugged.java b/src/main/java/org/orekit/rugged/api/Rugged.java
index 62c04bd8..a38a2798 100644
--- a/src/main/java/org/orekit/rugged/api/Rugged.java
+++ b/src/main/java/org/orekit/rugged/api/Rugged.java
@@ -30,87 +30,6 @@ import org.orekit.utils.PVCoordinates;
*/
public interface Rugged {
- /** Enumerate for ellipsoid. */
- enum Ellipsoid {
-
- /** Constant for GRS 80 ellipsoid. */
- GRS80,
-
- /** Constant for WGS 84 ellipsoid. */
- WGS84,
-
- /** Constant for IERS 96 ellipsoid. */
- IERS96,
-
- /** Constant for IERS 2003 ellipsoid. */
- IERS2003
-
- }
-
- /** Enumerate for inertial frames. */
- enum InertialFrame {
-
- /** Constant for Geocentric Celestial Reference Frame. */
- GCRF,
-
- /** Constant for Earth Mean Equator 2000 frame (aka J2000). */
- EME2000,
-
- /** Constant for Mean Of Date frame, with IERS 96 conventions (Lieske precession). */
- MOD,
-
- /** Constant for True Of Date frame, with IERS 96 conventions (Wahr nutation). */
- TOD,
-
- /** Constant for Veis 1950 frame. */
- VEIS1950
-
- }
-
- /** Enumerate for body rotating frames. */
- enum BodyRotatingFrame {
-
- /** Constant for International Terrestrial Reference Frame. */
- ITRF,
-
- /** Constant for International Terrestrial Reference Frame based on older equinox paradigm. */
- ITRF_EQUINOX,
-
- /** Constant for Geocentric True Of Date frame. */
- GTOD
-
- }
-
- /** Enumerate for Digital Elevation Model intersection. */
- enum Algorithm {
-
- /** Fast algorithm due to Bernardt Duvenhage.
- * <p>
- * The algorithm is described in the 2009 paper:
- * <a href="http://researchspace.csir.co.za/dspace/bitstream/10204/3041/1/Duvenhage_2009.pdf">Using
- * An Implicit Min/Max KD-Tree for Doing Efficient Terrain Line of Sight Calculations</a>.
- * </p>
- */
- DUVENHAGE,
-
- /** Basic, <em>very slow</em> algorithm, designed only for tests and validation purposes.
- * <p>
- * The algorithm simply computes entry and exit points at high and low altitudes,
- * and scans all Digital Elevation Models in the sub-tiles defined by these two
- * corner points. It is not designed for operational use.
- * </p>
- */
- BASIC_SLOW_EXHAUSTIVE_SCAN_FOR_TESTS_ONLY,
-
- /** Dummy algorithm that simply ignores the Digital Elevation Model.
- * <p>
- * Intersections are computed only with respect to the reference ellipsoid.
- * </p>
- */
- IGNORE_DEM_USE_ELLIPSOID
-
- }
-
/** Set up general context.
* <p>
* This method is the first one that must be called, otherwise the
@@ -129,8 +48,8 @@ public interface Rugged {
* @exception RuggedException if data needed for some frame cannot be loaded
*/
void setGeneralContext(AbsoluteDate referenceDate,
- Algorithm algorithmID, Ellipsoid ellipsoidID,
- InertialFrame inertialFrameID, BodyRotatingFrame bodyRotatingFrameID,
+ AlgorithmId algorithmID, EllipsoidId ellipsoidID,
+ InertialFrameId inertialFrameID, BodyRotatingFrameId bodyRotatingFrameID,
List<Pair<AbsoluteDate, PVCoordinates>> positionsVelocities, int pvInterpolationOrder,
List<Pair<AbsoluteDate, Rotation>> quaternions, int aInterpolationOrder)
throws RuggedException;
diff --git a/src/main/java/org/orekit/rugged/core/RuggedImpl.java b/src/main/java/org/orekit/rugged/core/RuggedImpl.java
index 02596c5b..8a37a610 100644
--- a/src/main/java/org/orekit/rugged/core/RuggedImpl.java
+++ b/src/main/java/org/orekit/rugged/core/RuggedImpl.java
@@ -35,6 +35,10 @@ import org.orekit.frames.Transform;
import org.orekit.orbits.CartesianOrbit;
import org.orekit.orbits.Orbit;
import org.orekit.propagation.Propagator;
+import org.orekit.rugged.api.AlgorithmId;
+import org.orekit.rugged.api.BodyRotatingFrameId;
+import org.orekit.rugged.api.EllipsoidId;
+import org.orekit.rugged.api.InertialFrameId;
import org.orekit.rugged.api.LineDatation;
import org.orekit.rugged.api.PixelLOS;
import org.orekit.rugged.api.Rugged;
@@ -83,9 +87,9 @@ public class RuggedImpl implements Rugged {
/** {@inheritDoc} */
@Override
public void setGeneralContext(final AbsoluteDate newReferenceDate,
- final Algorithm algorithmID, final Ellipsoid ellipsoidID,
- final InertialFrame inertialFrameID,
- final BodyRotatingFrame bodyRotatingFrameID,
+ final AlgorithmId algorithmID, final EllipsoidId ellipsoidID,
+ final InertialFrameId inertialFrameID,
+ final BodyRotatingFrameId bodyRotatingFrameID,
final List<Pair<AbsoluteDate, PVCoordinates>> positionsVelocities, final int pvInterpolationOrder,
final List<Pair<AbsoluteDate, Rotation>> quaternions, final int aInterpolationOrder)
throws RuggedException {
@@ -125,9 +129,9 @@ public class RuggedImpl implements Rugged {
* @exception RuggedException if data needed for some frame cannot be loaded
*/
public void setGeneralContext(final AbsoluteDate newReferenceDate,
- final Algorithm algorithmID, final Ellipsoid ellipsoidID,
- final InertialFrame inertialFrameID,
- final BodyRotatingFrame bodyRotatingFrameID,
+ final AlgorithmId algorithmID, final EllipsoidId ellipsoidID,
+ final InertialFrameId inertialFrameID,
+ final BodyRotatingFrameId bodyRotatingFrameID,
final Propagator propagator)
throws RuggedException {
try {
@@ -182,7 +186,7 @@ public class RuggedImpl implements Rugged {
* @return inertial frame
* @exception OrekitException if data needed for some frame cannot be loaded
*/
- private Frame selectInertialFrame(final InertialFrame inertialFrame)
+ private Frame selectInertialFrame(final InertialFrameId inertialFrame)
throws OrekitException {
// set up the inertial frame
@@ -209,7 +213,7 @@ public class RuggedImpl implements Rugged {
* @return body rotating frame
* @exception OrekitException if data needed for some frame cannot be loaded
*/
- private Frame selectBodyRotatingFrame(final BodyRotatingFrame bodyRotatingFrame)
+ private Frame selectBodyRotatingFrame(final BodyRotatingFrameId bodyRotatingFrame)
throws OrekitException {
// set up the rotating frame
@@ -233,7 +237,7 @@ public class RuggedImpl implements Rugged {
* @return selected ellipsoid
* @exception OrekitException if data needed for some frame cannot be loaded
*/
- private ExtendedEllipsoid selectEllipsoid(final Ellipsoid ellipsoidID, final Frame bodyFrame)
+ private ExtendedEllipsoid selectEllipsoid(final EllipsoidId ellipsoidID, final Frame bodyFrame)
throws OrekitException {
// set up the ellipsoid
@@ -312,7 +316,7 @@ public class RuggedImpl implements Rugged {
* @param algorithmID intersection algorithm identifier
* @return selected algorithm
*/
- private IntersectionAlgorithm selectAlgorithm(final Algorithm algorithmID) {
+ private IntersectionAlgorithm selectAlgorithm(final AlgorithmId algorithmID) {
// set up the algorithm
switch (algorithmID) {
diff --git a/src/test/java/org/orekit/rugged/core/RuggedImplTest.java b/src/test/java/org/orekit/rugged/core/RuggedImplTest.java
index 30d07321..33cfa2f2 100644
--- a/src/test/java/org/orekit/rugged/core/RuggedImplTest.java
+++ b/src/test/java/org/orekit/rugged/core/RuggedImplTest.java
@@ -60,6 +60,10 @@ import org.orekit.orbits.PositionAngle;
import org.orekit.propagation.Propagator;
import org.orekit.propagation.SpacecraftState;
import org.orekit.propagation.numerical.NumericalPropagator;
+import org.orekit.rugged.api.AlgorithmId;
+import org.orekit.rugged.api.BodyRotatingFrameId;
+import org.orekit.rugged.api.EllipsoidId;
+import org.orekit.rugged.api.InertialFrameId;
import org.orekit.rugged.api.LineDatation;
import org.orekit.rugged.api.LinearLineDatation;
import org.orekit.rugged.api.PixelLOS;
@@ -136,10 +140,10 @@ public class RuggedImplTest {
RuggedImpl rugged = new RuggedImpl();
rugged.setGeneralContext(t0,
- Rugged.Algorithm.DUVENHAGE,
- Rugged.Ellipsoid.WGS84,
- Rugged.InertialFrame.EME2000,
- Rugged.BodyRotatingFrame.ITRF,
+ AlgorithmId.DUVENHAGE,
+ EllipsoidId.WGS84,
+ InertialFrameId.EME2000,
+ BodyRotatingFrameId.ITRF,
pv, 8, q, 8);
Assert.assertEquals(new AbsoluteDate("2012-01-01T00:00:00", TimeScalesFactory.getUTC()),
@@ -160,10 +164,10 @@ public class RuggedImplTest {
RuggedImpl rugged = new RuggedImpl();
rugged.setGeneralContext(propagator.getInitialState().getDate(),
- Rugged.Algorithm.DUVENHAGE,
- Rugged.Ellipsoid.WGS84,
- Rugged.InertialFrame.EME2000,
- Rugged.BodyRotatingFrame.ITRF,
+ AlgorithmId.DUVENHAGE,
+ EllipsoidId.WGS84,
+ InertialFrameId.EME2000,
+ BodyRotatingFrameId.ITRF,
propagator);
Assert.assertEquals(propagator.getInitialState().getDate(), rugged.getReferenceDate());
@@ -211,10 +215,10 @@ public class RuggedImplTest {
RuggedImpl rugged = new RuggedImpl();
rugged.setGeneralContext(crossing,
- Rugged.Algorithm.DUVENHAGE,
- Rugged.Ellipsoid.WGS84,
- Rugged.InertialFrame.EME2000,
- Rugged.BodyRotatingFrame.ITRF,
+ AlgorithmId.DUVENHAGE,
+ EllipsoidId.WGS84,
+ InertialFrameId.EME2000,
+ BodyRotatingFrameId.ITRF,
ephemeris);
rugged.setUpTilesManagement(updater, 8);
--
GitLab