Merge branch 'mueller/refactor-tmtc-stack' into mueller/cfdp-routers

CHANGELOG.md

@@ -8,10 +8,19 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 # [unreleased]
 
+# [v6.0.0]
+
 ## Added
 
 - Add new `UnsignedByteField` class
 
+## Changes
+
+- Overhaul of the TMTC stack, including various changes and improvements
+  for other modules
+  PR: https://egit.irs.uni-stuttgart.de/fsfw/fsfw/pulls/655
+  which also includes a migration guide
+
 # [v5.0.0] 25.07.2022
 
 ## Changes

src/fsfw/objectmanager/frameworkObjects.h

@@ -33,7 +33,7 @@ enum framework_objects : object_id_t {
   TC_STORE = 0x534f0100,
   TM_STORE = 0x534f0200,
   TIME_STAMPER = 0x53500010,
-  TC_VERIFICATOR = 0x53500020,
+  VERIFICATION_REPORTER = 0x53500020,
 
   FSFW_OBJECTS_END = 0x53ffffff,
   NO_OBJECT = 0xFFFFFFFF

src/fsfw/tcdistribution/PusDistributor.cpp

@@ -134,7 +134,7 @@ ReturnValue_t PusDistributor::initialize() {
     return ObjectManagerIF::CHILD_INIT_FAILED;
   }
   if (verifyChannel == nullptr) {
-    verifyChannel = ObjectManager::instance()->get<VerificationReporterIF>(objects::TC_VERIFICATOR);
+    verifyChannel = ObjectManager::instance()->get<VerificationReporterIF>(objects::VERIFICATION_REPORTER);
     if (verifyChannel == nullptr) {
       return ObjectManagerIF::CHILD_INIT_FAILED;
     }

src/fsfw/tmtcservices/CommandingServiceBase.cpp

@@ -126,7 +126,7 @@ ReturnValue_t CommandingServiceBase::initialize() {
 
   if (verificationReporter == nullptr) {
     verificationReporter =
-        ObjectManager::instance()->get<VerificationReporterIF>(objects::TC_VERIFICATOR);
+        ObjectManager::instance()->get<VerificationReporterIF>(objects::VERIFICATION_REPORTER);
     if (verificationReporter == nullptr) {
       return ObjectManagerIF::CHILD_INIT_FAILED;
     }

src/fsfw/tmtcservices/PusServiceBase.cpp

@@ -126,7 +126,7 @@ ReturnValue_t PusServiceBase::initialize() {
 
   if (psbParams.verifReporter == nullptr) {
     psbParams.verifReporter =
-        ObjectManager::instance()->get<VerificationReporterIF>(objects::TC_VERIFICATOR);
+        ObjectManager::instance()->get<VerificationReporterIF>(objects::VERIFICATION_REPORTER);
     if (psbParams.verifReporter == nullptr) {
       return ObjectManagerIF::CHILD_INIT_FAILED;
     }

src/fsfw/tmtcservices/VerificationReporter.cpp

@@ -5,9 +5,9 @@
 #include "fsfw/tmtcservices/PusVerificationReport.h"
 
 object_id_t VerificationReporter::DEFAULT_RECEIVER = objects::PUS_SERVICE_1_VERIFICATION;
-object_id_t VerificationReporter::DEFAULT_REPORTER = objects::TC_VERIFICATOR;
+object_id_t VerificationReporter::DEFAULT_REPORTER = objects::VERIFICATION_REPORTER;
 
-VerificationReporter::VerificationReporter(AcceptsVerifyMessageIF* receiver, object_id_t objectId)
+VerificationReporter::VerificationReporter(object_id_t objectId, AcceptsVerifyMessageIF* receiver)
     : SystemObject(objectId) {
   if (receiver != nullptr) {
     acknowledgeQueue = receiver->getVerificationQueue();

src/fsfw/tmtcservices/VerificationReporter.h

@@ -27,8 +27,8 @@ class VerificationReporter : public SystemObject, public VerificationReporterIF
   friend void Factory::setStaticFrameworkObjectIds();
 
  public:
-  explicit VerificationReporter(AcceptsVerifyMessageIF* receiver,
+  explicit VerificationReporter(object_id_t objectId = DEFAULT_REPORTER,
-                                object_id_t objectId = DEFAULT_REPORTER);
+                                AcceptsVerifyMessageIF* receiver = nullptr);
   ~VerificationReporter() override;
 
   void setReceiver(AcceptsVerifyMessageIF& receiver);

unittests/tmtcservices/testPsb.cpp

@@ -211,7 +211,7 @@ TEST_CASE("Pus Service Base", "[pus-service-base]") {
   SECTION("Auto Initialize Verification Reporter") {
     psbParams.verifReporter = nullptr;
     psbParams.objectId = 1;
-    object_id_t reporterId = objects::TC_VERIFICATOR;
+    object_id_t reporterId = objects::VERIFICATION_REPORTER;
     PusVerificationReporterMock otherReporter(reporterId);
     auto psb2 = PsbMock(psbParams);
     REQUIRE(psb2.initialize() == result::OK);