Rename Fw/SMTest to Fw/Sm

garthwatney · Sep 3, 2024 · 443da3b · 443da3b
1 parent 08d8135
commit 443da3b
Show file tree

Hide file tree

Showing 17 changed files with 36 additions and 93 deletions.
diff --git a/FppTest/state_machine/CMakeLists.txt b/FppTest/state_machine/CMakeLists.txt
@@ -4,7 +4,7 @@ set(SOURCE_FILES
     "${CMAKE_CURRENT_LIST_DIR}/DeviceSm.cpp"
     "${CMAKE_CURRENT_LIST_DIR}/HackSm.cpp"
 )
-set(MOD_DEPS Fw/SMSignal)
+set(MOD_DEPS Fw/Sm)
 
 register_fprime_module()
 

diff --git a/FppTest/state_machine/DeviceSm.cpp b/FppTest/state_machine/DeviceSm.cpp
@@ -8,7 +8,6 @@
 
 #include "stdio.h"
 #include "assert.h"
-#include "Fw/Types/SMSignalsSerializableAc.hpp"
 #include "DeviceSm.hpp"
 
 
@@ -22,7 +21,7 @@ void FppTest::DeviceSm::init(const FwEnumStoreType stateMachineId)
 
 void FppTest::DeviceSm::update(
     const FwEnumStoreType stateMachineId, 
-    const DeviceSm_Interface::DeviceSmEvents signal, 
+    const DeviceSm_Interface::DeviceSm_Signals signal, 
     const Fw::SMSignalBuffer &data
 )
 {
@@ -35,7 +34,7 @@ void FppTest::DeviceSm::update(
 
             switch (signal) {
 
-                case DeviceSm_Interface::DeviceSmEvents::RTI_SIG:
+                case DeviceSm_Interface::DeviceSm_Signals::RTI_SIG:
                         if ( parent->DeviceSm_g1(stateMachineId) ) {
                             parent->DeviceSm_a1(stateMachineId, signal, data);
                             parent->DeviceSm_turnOn(stateMachineId);
@@ -56,7 +55,7 @@ void FppTest::DeviceSm::update(
 
             switch (signal) {
 
-                case DeviceSm_Interface::DeviceSmEvents::RTI_SIG:
+                case DeviceSm_Interface::DeviceSm_Signals::RTI_SIG:
                         if (parent->DeviceSm_g2(stateMachineId, signal, data) ) {
                             parent->DeviceSm_a2(stateMachineId);
                             parent->DeviceSm_turnOff(stateMachineId);

diff --git a/FppTest/state_machine/DeviceSm.hpp b/FppTest/state_machine/DeviceSm.hpp
@@ -9,18 +9,14 @@
 #ifndef DEVICESM_H_
 #define DEVICESM_H_
 
-#include <Fw/SMSignal/SMSignalBuffer.hpp>
+#include <Fw/Sm/SMSignalBuffer.hpp>
 #include <config/FpConfig.hpp>
 
-namespace Fw {
-  class SMSignals;
-}
-
 namespace FppTest {
 
 class DeviceSm_Interface {
   public:
-    enum DeviceSmEvents {
+    enum DeviceSm_Signals {
       RTI_SIG,
     };
 
@@ -30,7 +26,7 @@ class DeviceSm_Interface {
 
     virtual bool DeviceSm_g2(
         const FwEnumStoreType stateMachineId, 
-        const DeviceSm_Interface::DeviceSmEvents signal, 
+        const DeviceSm_Interface::DeviceSm_Signals signal, 
         const Fw::SMSignalBuffer &data) = 0;
 
 
@@ -39,7 +35,7 @@ class DeviceSm_Interface {
 
     virtual  void DeviceSm_a1(
         const FwEnumStoreType stateMachineId, 
-        const DeviceSm_Interface::DeviceSmEvents signal, 
+        const DeviceSm_Interface::DeviceSm_Signals signal, 
         const Fw::SMSignalBuffer &data) = 0;
 
 
@@ -60,19 +56,17 @@ class DeviceSm {
 
     DeviceSm(DeviceSm_Interface* parent) : parent(parent) {}
 
-    enum DeviceSmStates {
+    enum DeviceSm_States {
       OFF,
       ON,
     };
 
-    enum DeviceSmStates state;
-
-    void * extension;
+    enum DeviceSm_States state;
 
     void init(const FwEnumStoreType stateMachineId);
     void update(
         const FwEnumStoreType stateMachineId, 
-        const DeviceSm_Interface::DeviceSmEvents signal, 
+        const DeviceSm_Interface::DeviceSm_Signals signal, 
         const Fw::SMSignalBuffer &data
     );
 };

diff --git a/FppTest/state_machine/HackSm.cpp b/FppTest/state_machine/HackSm.cpp
@@ -8,7 +8,6 @@
 
 #include "stdio.h"
 #include "assert.h"
-#include "Fw/Types/SMSignalsSerializableAc.hpp"
 #include "HackSm.hpp"
 
 
@@ -22,7 +21,7 @@ void FppTest::HackSm::init(const FwEnumStoreType stateMachineId)
 
 void FppTest::HackSm::update(
     const FwEnumStoreType stateMachineId, 
-    const HackSm_Interface::HackSmEvents signal, 
+    const HackSm_Interface::HackSm_Signals signal, 
     const Fw::SMSignalBuffer &data
 )
 {
@@ -35,13 +34,13 @@ void FppTest::HackSm::update(
 
             switch (signal) {
 
-                case HackSm_Interface::HackSmEvents::RTI_SIG:
+                case HackSm_Interface::HackSm_Signals::RTI_SIG:
                         parent->HackSm_turnOn(stateMachineId);
                         this->state = ON;
 
                     break;
 
-                case HackSm_Interface::HackSmEvents::CHECK_SIG:
+                case HackSm_Interface::HackSm_Signals::CHECK_SIG:
                         parent->HackSm_doDiag(stateMachineId);
                         this->state = DIAG;
 
@@ -59,13 +58,13 @@ void FppTest::HackSm::update(
 
             switch (signal) {
 
-                case HackSm_Interface::HackSmEvents::RTI_SIG:
+                case HackSm_Interface::HackSm_Signals::RTI_SIG:
                         parent->HackSm_turnOff(stateMachineId);
                         this->state = OFF;
 
                     break;
 
-                case HackSm_Interface::HackSmEvents::CHECK_SIG:
+                case HackSm_Interface::HackSm_Signals::CHECK_SIG:
                         parent->HackSm_doDiag(stateMachineId);
                         this->state = DIAG;
 
@@ -83,7 +82,7 @@ void FppTest::HackSm::update(
 
             switch (signal) {
 
-                case HackSm_Interface::HackSmEvents::RTI_SIG:
+                case HackSm_Interface::HackSm_Signals::RTI_SIG:
                         parent->HackSm_turnOff(stateMachineId);
                         this->state = OFF;
 

diff --git a/FppTest/state_machine/HackSm.hpp b/FppTest/state_machine/HackSm.hpp
@@ -9,18 +9,14 @@
 #ifndef HACKSM_H_
 #define HACKSM_H_
 
-#include <Fw/SMSignal/SMSignalBuffer.hpp>
+#include <Fw/Sm/SMSignalBuffer.hpp>
 #include <config/FpConfig.hpp>
 
-namespace Fw {
-  class SMSignals;
-}
-
 namespace FppTest {
 
 class HackSm_Interface {
   public:
-    enum HackSmEvents {
+    enum HackSm_Signals {
       RTI_SIG,
       CHECK_SIG,
     };
@@ -46,20 +42,18 @@ class HackSm {
 
     HackSm(HackSm_Interface* parent) : parent(parent) {}
 
-    enum HackSmStates {
+    enum HackSm_States {
       OFF,
       ON,
       DIAG,
     };
 
-    enum HackSmStates state;
-
-    void * extension;
+    enum HackSm_States state;
 
     void init(const FwEnumStoreType stateMachineId);
     void update(
         const FwEnumStoreType stateMachineId, 
-        const HackSm_Interface::HackSmEvents signal, 
+        const HackSm_Interface::HackSm_Signals signal, 
         const Fw::SMSignalBuffer &data
     );
 };

diff --git a/FppTest/state_machine/SmTest.cpp b/FppTest/state_machine/SmTest.cpp
@@ -31,17 +31,17 @@ SmTest ::~SmTest() {}
 void SmTest::schedIn_handler(const NATIVE_INT_TYPE portNum, U32 context) {
     Fw::SMSignalBuffer data;
 
-    device1_stateMachineInvoke(DeviceSm_Interface::DeviceSmEvents::RTI_SIG, data);
-    device2_stateMachineInvoke(DeviceSm_Interface::DeviceSmEvents::RTI_SIG, data);
-    device3_stateMachineInvoke(HackSm_Interface::HackSmEvents::RTI_SIG, data);
-    device4_stateMachineInvoke(HackSm_Interface::HackSmEvents::RTI_SIG, data);
-    device5_stateMachineInvoke(HackSm_Interface::HackSmEvents::RTI_SIG, data);
+    device1_stateMachineInvoke(DeviceSm_Interface::DeviceSm_Signals::RTI_SIG, data);
+    device2_stateMachineInvoke(DeviceSm_Interface::DeviceSm_Signals::RTI_SIG, data);
+    device3_stateMachineInvoke(HackSm_Interface::HackSm_Signals::RTI_SIG, data);
+    device4_stateMachineInvoke(HackSm_Interface::HackSm_Signals::RTI_SIG, data);
+    device5_stateMachineInvoke(HackSm_Interface::HackSm_Signals::RTI_SIG, data);
 
 }
 
 //! Overflow hook for state machine device4
 void SmTest::device4_stateMachineOverflowHook(
-    const HackSm_Interface::HackSmEvents signal, //!< The state machine signal
+    const HackSm_Interface::HackSm_Signals signal, //!< The state machine signal
     const Fw::SMSignalBuffer& data //!< The state machine data
 ) {
 
@@ -57,7 +57,7 @@ void SmTest::DeviceSm_turnOff(const FwEnumStoreType stateMachineId) {
 
 void SmTest::DeviceSm_a1(
     const FwEnumStoreType stateMachineId, 
-    const DeviceSmEvents signal, 
+    const DeviceSm_Signals signal, 
     const Fw::SMSignalBuffer& data
     ) {
     printf("Action 1, stateMachineId = %d, signal = %d\n", stateMachineId, signal);
@@ -70,7 +70,7 @@ void SmTest::DeviceSm_a1(
 
  bool SmTest::DeviceSm_g2(
       const FwEnumStoreType stateMachineId, 
-      const DeviceSmEvents signal, 
+      const DeviceSm_Signals signal, 
       const Fw::SMSignalBuffer& data
     ) {
         return true;

diff --git a/FppTest/state_machine/SmTest.hpp b/FppTest/state_machine/SmTest.hpp
@@ -69,7 +69,7 @@ class SmTest :
 
     //! Overflow hook for state machine device4
     void device4_stateMachineOverflowHook(
-        const HackSm_Interface::HackSmEvents signal, //!< The state machine signal
+        const HackSm_Interface::HackSm_Signals signal, //!< The state machine signal
         const Fw::SMSignalBuffer& data //!< The state machine data
     );
 
@@ -80,7 +80,7 @@ class SmTest :
 
     void DeviceSm_a1(
       const FwEnumStoreType stateMachineId, 
-      const DeviceSmEvents signal, 
+      const DeviceSm_Signals signal, 
       const Fw::SMSignalBuffer& data
     );
 
@@ -90,7 +90,7 @@ class SmTest :
 
     bool DeviceSm_g2(
       const FwEnumStoreType stateMachineId, 
-      const DeviceSmEvents signal, 
+      const DeviceSm_Signals signal, 
       const Fw::SMSignalBuffer& data
     );
 

diff --git a/FppTest/state_machine/test/ut/Tester.cpp b/FppTest/state_machine/test/ut/Tester.cpp
@@ -52,7 +52,7 @@ void Tester::schedIn_OK() {
     ASSERT_EQ(DeviceSm::OFF, this->component.m_stateMachine_device5.state);
 
     Fw::SMSignalBuffer data;
-    this->component.device3_stateMachineInvoke(HackSm_Interface::HackSmEvents::CHECK_SIG, data);
+    this->component.device3_stateMachineInvoke(HackSm_Interface::HackSm_Signals::CHECK_SIG, data);
     dispatchAll();
     ASSERT_EQ(HackSm::DIAG, this->component.m_stateMachine_device3.state);
     invoke_to_schedIn(0,0);

diff --git a/Fw/CMakeLists.txt b/Fw/CMakeLists.txt
@@ -14,7 +14,7 @@ add_fprime_subdirectory("${CMAKE_CURRENT_LIST_DIR}/Tlm/")
 # Framework subdirectories
 add_fprime_subdirectory("${CMAKE_CURRENT_LIST_DIR}/Cfg/")
 add_fprime_subdirectory("${CMAKE_CURRENT_LIST_DIR}/Comp/")
-add_fprime_subdirectory("${CMAKE_CURRENT_LIST_DIR}/SMSignal/")
+add_fprime_subdirectory("${CMAKE_CURRENT_LIST_DIR}/Sm/")
 add_fprime_subdirectory("${CMAKE_CURRENT_LIST_DIR}/FilePacket/")
 add_fprime_subdirectory("${CMAKE_CURRENT_LIST_DIR}/Obj/")
 add_fprime_subdirectory("${CMAKE_CURRENT_LIST_DIR}/Port/")

diff --git a/Fw/SMSignal/docs/.gitignore b/Fw/SMSignal/docs/.gitignore
diff --git a/Fw/SMSignal/docs/img/FwComBDD.jpg b/Fw/SMSignal/docs/img/FwComBDD.jpg
diff --git a/Fw/SMSignal/docs/sdd.md b/Fw/SMSignal/docs/sdd.md
diff --git a/Fw/SMSignal/CMakeLists.txt → Fw/Sm/CMakeLists.txt b/Fw/SMSignal/CMakeLists.txt → Fw/Sm/CMakeLists.txt
diff --git a/Fw/SMSignal/README → Fw/Sm/README b/Fw/SMSignal/README → Fw/Sm/README
diff --git a/Fw/SMSignal/SMSignalBuffer.cpp → Fw/Sm/SMSignalBuffer.cpp b/Fw/SMSignal/SMSignalBuffer.cpp → Fw/Sm/SMSignalBuffer.cpp
@@ -1,4 +1,4 @@
-#include <Fw/SMSignal/SMSignalBuffer.hpp>
+#include <Fw/Sm/SMSignalBuffer.hpp>
 #include <Fw/Types/Assert.hpp>
 
 namespace Fw {

diff --git a/Fw/SMSignal/SMSignalBuffer.hpp → Fw/Sm/SMSignalBuffer.hpp b/Fw/SMSignal/SMSignalBuffer.hpp → Fw/Sm/SMSignalBuffer.hpp
diff --git a/Fw/Types/Types.fpp b/Fw/Types/Types.fpp
@@ -13,12 +13,6 @@ module Fw {
     NO_ROOM_LEFT  @< No room left in the buffer to serialize data
   }
 
-  struct SMSignals {
-        smId : U32
-        eventSignal: U32
-        payload: [128] U8
-  }
-
   @ Deserialization status
   enum DeserialStatus {
     OK = 0