fix: harmonize depracation warnings (#562)

* fix: harmonize depracation warnings

* fix: add disable delcarations

Author: apaletta3

CMakeLists.txt

@@ -27,6 +27,7 @@ OPTION (BUILD_SCRIPT "Build script" OFF)
 OPTION (BUILD_WITH_CXX_17 "Build with C++ 17 support." OFF)
 OPTION (BUILD_WITH_BOOST_STACKTRACE "Build with Boost Stacktrace instead of stacktrace basic" ON)
 OPTION (BUILD_WITH_BOOST_STATIC "Build with Boost Static lib" ON)
+OPTION (BUILD_WITHOUT_DEPRECATED_DECLARATION_WARNINGS "Build without deprecated declaration warnings" OFF)
 
 ## Setup
 
@@ -167,6 +168,14 @@ IF (BUILD_WITH_DEBUG_SYMBOLS)
 
 ENDIF ()
 
+### Warnings
+
+IF (BUILD_WITHOUT_DEPRECATED_DECLARATION_WARNINGS)
+
+    SET (CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wno-deprecated-declarations")
+
+ENDIF ()
+
 ### Debugging Options
 
 SET (CMAKE_VERBOSE_MAKEFILE 0) # Use 1 for debugging, 0 for release

bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Flight/Profile.cpp

@@ -55,7 +55,7 @@ inline void OpenSpaceToolkitAstrodynamicsPy_Flight_Profile(pybind11::module& aMo
 
         .value("GeocentricNadir", Profile::TargetType::GeocentricNadir, "Geocentric nadir")
         .value("GeodeticNadir", Profile::TargetType::GeodeticNadir, "Geodetic nadir")
-        .value("Trajectory", Profile::TargetType::Trajectory, "Trajectory")  // Deprecated in favor of TargetPosition
+        .value("Trajectory", Profile::TargetType::Trajectory, "Deprecated - Use TargetPosition instead.")
         .value("TargetPosition", Profile::TargetType::TargetPosition, "Target position")
         .value("TargetVelocity", Profile::TargetType::TargetVelocity, "Target velocity")
         .value(
@@ -114,7 +114,14 @@ inline void OpenSpaceToolkitAstrodynamicsPy_Flight_Profile(pybind11::module& aMo
     )
 
         .def(
-            init<const Trajectory&, const Profile::Axis&, const bool&&>(),
+            init(
+                +[](const Trajectory& trajectory, const Profile::Axis& axis, const bool& antiDirection
+                 ) -> Profile::TrajectoryTarget
+                {
+                    PyErr_WarnEx(PyExc_DeprecationWarning, "Use TrajectoryTarget.target_position(...) instead.", 1);
+                    return Profile::TrajectoryTarget(trajectory, axis, antiDirection);
+                }
+            ),
             R"doc(
                 Constructor.
 

bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Trajectory.cpp

@@ -27,6 +27,7 @@ inline void OpenSpaceToolkitAstrodynamicsPy_Trajectory(pybind11::module& aModule
     using ostk::physics::unit::Derived;
 
     using ostk::astrodynamics::Trajectory;
+    using ostk::astrodynamics::trajectory::Orbit;
     using ostk::astrodynamics::trajectory::State;
 
     class_<Trajectory, Shared<Trajectory>>(
@@ -152,9 +153,18 @@ inline void OpenSpaceToolkitAstrodynamicsPy_Trajectory(pybind11::module& aModule
         )
         .def_static(
             "ground_strip",
-            overload_cast<const LLA&, const LLA&, const Derived&, const Instant&, const Celestial&, const Duration&>(
-                &Trajectory::GroundStrip
-            ),
+            +[](const LLA& aStartLLA,
+                const LLA& anEndLLA,
+                const Derived& aGroundSpeed,
+                const Instant& aStartInstant,
+                const Celestial& aCelestial,
+                const Duration& aStepSize) -> Trajectory
+            {
+                PyErr_WarnEx(
+                    PyExc_DeprecationWarning, "Use Trajectory(model=TargetScan.from_ground_speed(...)) instead.", 1
+                );
+                return Trajectory::GroundStrip(aStartLLA, anEndLLA, aGroundSpeed, aStartInstant, aCelestial, aStepSize);
+            },
             R"doc(
                 Create a `Trajectory` object representing a ground strip.
                 Computes the duration as the geodetic distance / ground speed.
@@ -181,7 +191,14 @@ inline void OpenSpaceToolkitAstrodynamicsPy_Trajectory(pybind11::module& aModule
         )
         .def_static(
             "ground_strip",
-            overload_cast<const LLA&, const LLA&, const Array<Instant>&, const Celestial&>(&Trajectory::GroundStrip),
+            +[](const LLA& aStartLLA,
+                const LLA& anEndLLA,
+                const Array<Instant>& anInstantArray,
+                const Celestial& aCelestial) -> Trajectory
+            {
+                PyErr_WarnEx(PyExc_DeprecationWarning, "Use Trajectory(model=TargetScan(...)) instead.", 1);
+                return Trajectory::GroundStrip(aStartLLA, anEndLLA, anInstantArray, aCelestial);
+            },
             R"doc(
                 Create a `Trajectory` object representing a ground strip.
                 This method computes the duration as the geodetic distance / ground speed.
@@ -203,7 +220,11 @@ inline void OpenSpaceToolkitAstrodynamicsPy_Trajectory(pybind11::module& aModule
         )
         .def_static(
             "ground_strip_geodetic_nadir",
-            &Trajectory::GroundStripGeodeticNadir,
+            +[](const Orbit& anOrbit, const Array<Instant>& anInstantArray, const Celestial& aCelestial) -> Trajectory
+            {
+                PyErr_WarnEx(PyExc_DeprecationWarning, "Use Trajectory(model=Nadir(...)) instead.", 1);
+                return Trajectory::GroundStripGeodeticNadir(anOrbit, anInstantArray, aCelestial);
+            },
             R"doc(
                 Create a `Trajectory` object representing a ground strip that follows the geodetic nadir of the provided orbit.
 
@@ -213,7 +234,7 @@ inline void OpenSpaceToolkitAstrodynamicsPy_Trajectory(pybind11::module& aModule
                     celestial_object (Celestial): The celestial object. Defaults to Earth.WGS84().
 
                 Returns:
-                    Trajectory: The `Trajectory` object representing the ground strip.  
+                    Trajectory: The `Trajectory` object representing the ground strip.
             )doc",
             arg("orbit"),
             arg("instants"),

bindings/python/test/flight/test_profile.py

@@ -97,6 +97,10 @@ def profile(request) -> Profile:
 @pytest.fixture(
     params=[
         Profile.Target(Profile.TargetType.GeocentricNadir, Profile.Axis.X),
+        Profile.TrajectoryTarget(
+            Trajectory.position(Position.meters((0.0, 0.0, 0.0), Frame.ITRF())),
+            Profile.Axis.X,
+        ),
         Profile.TrajectoryTarget.target_position(
             Trajectory.position(Position.meters((0.0, 0.0, 0.0), Frame.ITRF())),
             Profile.Axis.X,

bindings/python/test/Trajectory/Model/test_nadir.py renamed to bindings/python/test/trajectory/model/test_nadir_trajectory.py

@@ -92,7 +92,7 @@ class Profile
     {
         GeocentricNadir,              /// Negative of the position vector of the satellite in the ECI frame
         GeodeticNadir,                /// Negative of the geodetic normal of the satellite in the ECI frame
-        Trajectory,                   /// Points towards the provided trajectory, eg. Ground Station in ECEF
+        Trajectory,                   /// DEPRECATED: Use TargetPosition instead.
         TargetPosition,               /// Points towards the provided target position
         TargetVelocity,               /// Points along the provided target's velocity vector
         TargetSlidingGroundVelocity,  /// Points along the provided target's ground velocity vector (aka the scan
@@ -128,10 +128,11 @@ class Profile
        public:
         /// @brief Constructs a TrajectoryTarget object.
         ///
+        /// @deprecated Use TrajectoryTarget::TargetPosition(...) instead.
         /// @param aTrajectory The trajectory to point towards.
         /// @param anAxis The axis of the target.
         /// @param isAntiDirection Whether the target is in the anti-direction.
-        [[deprecated("Use TrajectoryTarget::TargetPosition instead.")]]
+        [[deprecated("Use TrajectoryTarget::TargetPosition(...) instead.")]]
         TrajectoryTarget(
             const ostk::astrodynamics::Trajectory& aTrajectory, const Axis& anAxis, const bool& isAntiDirection = false
         );

bindings/python/test/Trajectory/Model/test_target_scan.py renamed to bindings/python/test/trajectory/model/test_target_scan_trajectory.py

@@ -56,8 +56,8 @@ class Tabulated : public virtual Model
     /// @brief Constructor
     ///
     /// @param aStateArray An array of states
-    /// @deprecated Use the constructor with Interpolator::Type instead
-    [[deprecated("Use the constructor with Interpolator::Type instead")]]
+    /// @deprecated Use the constructor with Interpolator::Type instead.
+    [[deprecated("Use the constructor with Interpolator::Type instead.")]]
     Tabulated(const Array<State>& aStateArray);
 
     /// @brief Constructor

include/OpenSpaceToolkit/Astrodynamics/Flight/Profile.hpp

@@ -195,7 +195,7 @@ class Trajectory
     ///             duration);
     /// @endcode
     ///
-    /// @deprecated Use Trajectory::TargetScan instead.
+    /// @deprecated Use Trajectory(TargetScan::FromGroundSpeed(...)) instead.
     /// @param aStartLLA A start LLA
     /// @param anEndLLA An end LLA
     /// @param aGroundSpeed A ground speed
@@ -225,7 +225,7 @@ class Trajectory
     ///             Trajectory trajectory = Trajectory::GroundStrip(startLLA, endLLA, instants, earth);
     /// @endcode
     ///
-    /// @deprecated Use Trajectory::TargetScan instead.
+    /// @deprecated Use Trajectory(TargetScan(...)) instead.
     /// @param aStartLLA A start LLA
     /// @param anEndLLA An end LLA
     /// @param anInstantArray An array of instants

include/OpenSpaceToolkit/Astrodynamics/Flight/Profile/Model/Tabulated.hpp

@@ -90,7 +90,7 @@ Profile::TrajectoryTarget::TrajectoryTarget(
     if (aType == TargetType::Trajectory)
     {
         throw ostk::core::error::RuntimeError(
-            "TrajectoryTarget::Trajectory is deprecated. Use TrajectoryTarget::TargetPosition instead."
+            "TargetType::Trajectory is deprecated. Use TargetType::TargetPosition instead."
         );
     }
 

include/OpenSpaceToolkit/Astrodynamics/Trajectory.hpp

@@ -252,7 +252,7 @@ Trajectory Trajectory::GroundStripGeodeticNadir(
     [[maybe_unused]] const Celestial& aCelestial
 )
 {
-    [[deprecated("Use Trajectory::GeodeticNadirGroundTrack instead.")]] return Trajectory(Nadir(anOrbit));
+    return Trajectory(Nadir(anOrbit));
 }
 
 Trajectory::Trajectory()