Merge pull request #597 from AVSLab/refactor/refactor-prescribedRotat…

…ion1DOF Port prescribedRot1DOF module to C++ with coast profiler
AVSLab · Mar 6, 2024 · 6f12949 · 6f12949
2 parents 4da8e1a + 9c80ffa
commit 6f12949
Show file tree

Hide file tree

Showing 9 changed files with 1,166 additions and 25 deletions.
diff --git a/docs/source/Support/bskReleaseNotes.rst b/docs/source/Support/bskReleaseNotes.rst
@@ -53,9 +53,12 @@ Version |release|
   ``opencv`` related flag had to be updated.
 - added supoport for Vizard 2.1.6
 - Created a :ref:`prescribedLinearTranslation` dynamics module to profile prescribed linear translation for a
-  secondary rigid body connected to the spacecraft hub. This new module deprecates the :ref:`prescribedTrans` module.
+  secondary rigid body connected to the spacecraft hub. This new module deprecates the ``prescribedTrans`` module.
   To simulate the translation, this module must be connected to the :ref:`prescribedMotionStateEffector`
   dynamics module.
+- Created a :ref:`prescribedRotation1DOF` dynamics module to profile a prescribed 1 DOF rotation for a secondary
+  rigid body connected to the spacecraft hub. This new module deprecates the ``prescribedRot1DOF`` fsw module.
+  To simulate the rotation, this module must be connected to the :ref:`prescribedMotionStateEffector` dynamics module.
 
 Version 2.2.1 (Dec. 22, 2023)
 -----------------------------

diff --git a/src/fswAlgorithms/effectorInterfaces/prescribedRot1DOF/prescribedRot1DOF.rst b/src/fswAlgorithms/effectorInterfaces/prescribedRot1DOF/prescribedRot1DOF.rst
@@ -20,6 +20,9 @@ constant negatively for the second half of the rotation. The resulting angular v
 linear, approaching a maximum magnitude halfway through the rotation and ending with zero residual velocity.
 The corresponding angle the prescribed body moves through during the rotation is parabolic in time.
 
+.. warning::
+    This module is now deprecated. See the :ref:`PrescribedRotation1DOF` module that replaces this module.
+
 Message Connection Descriptions
 -------------------------------
 The following table lists all the module input and output messages.  

diff --git a/...imulation/deviceInterface/prescribedRotation1DOF/_UnitTest/test_prescribedRotation1DOF.py b/...imulation/deviceInterface/prescribedRotation1DOF/_UnitTest/test_prescribedRotation1DOF.py