From 35be7da3534423af2b4db2b86e75371749181213 Mon Sep 17 00:00:00 2001 From: Robin Mueller Date: Thu, 9 Nov 2023 11:28:59 +0100 Subject: [PATCH] some more docs --- .../devicehandlers/FreshDeviceHandlerBase.cpp | 2 +- .../devicehandlers/FreshDeviceHandlerBase.h | 22 ++++++++++++------- 2 files changed, 15 insertions(+), 9 deletions(-) diff --git a/src/fsfw/devicehandlers/FreshDeviceHandlerBase.cpp b/src/fsfw/devicehandlers/FreshDeviceHandlerBase.cpp index 8de20494..22bf6f77 100644 --- a/src/fsfw/devicehandlers/FreshDeviceHandlerBase.cpp +++ b/src/fsfw/devicehandlers/FreshDeviceHandlerBase.cpp @@ -174,4 +174,4 @@ ReturnValue_t FreshDeviceHandlerBase::getParameter(uint8_t domainId, uint8_t uni return result; } return INVALID_DOMAIN_ID; -} +} \ No newline at end of file diff --git a/src/fsfw/devicehandlers/FreshDeviceHandlerBase.h b/src/fsfw/devicehandlers/FreshDeviceHandlerBase.h index c6002699..3646efd1 100644 --- a/src/fsfw/devicehandlers/FreshDeviceHandlerBase.h +++ b/src/fsfw/devicehandlers/FreshDeviceHandlerBase.h @@ -41,14 +41,6 @@ class FreshDeviceHandlerBase : public SystemObject, */ virtual void performDeviceOperation(uint8_t opCode) = 0; - /** - * Implemented by child class. Handle all command messages which are - * not health, mode, action or housekeeping messages. - * @param message - * @return - */ - virtual ReturnValue_t handleCommandMessage(CommandMessage* message) = 0; - [[nodiscard]] object_id_t getObjectId() const override; [[nodiscard]] MessageQueueId_t getCommandQueue() const override; @@ -90,6 +82,12 @@ class FreshDeviceHandlerBase : public SystemObject, // Mode Helpers. virtual void modeChanged(Mode_t mode, Submode_t submode); + /** + * The default implementation sets the new mode immediately. If this is not applicable for + * certain modes, the user should provide a custom implementation, which performs rougly + * the same functionality of this function, when all the steps have been taken to reach the + * new mode. + */ void startTransition(Mode_t mode, Submode_t submode) override; void getMode(Mode_t* mode, Submode_t* submode) override; void setToExternalControl() override; @@ -97,6 +95,14 @@ class FreshDeviceHandlerBase : public SystemObject, // System Object overrides. ReturnValue_t initialize() override; + /** + * Implemented by child class. Handle all command messages which are + * not health, mode, action or housekeeping messages. + * @param message + * @return + */ + virtual ReturnValue_t handleCommandMessage(CommandMessage* message) = 0; + // HK manager abstract functions. LocalPoolDataSetBase* getDataSetHandle(sid_t sid) override = 0; ReturnValue_t initializeLocalDataPool(localpool::DataPool& localDataPoolMap,