From d77dbe44c6b120e0df20b5033209a1c63d132335 Mon Sep 17 00:00:00 2001 From: Robin Mueller Date: Wed, 11 Dec 2024 13:54:16 +0100 Subject: [PATCH] some FDHB docs improvements --- src/fsfw/devicehandlers/FreshDeviceHandlerBase.h | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/src/fsfw/devicehandlers/FreshDeviceHandlerBase.h b/src/fsfw/devicehandlers/FreshDeviceHandlerBase.h index 643ffd9f..5ffa4720 100644 --- a/src/fsfw/devicehandlers/FreshDeviceHandlerBase.h +++ b/src/fsfw/devicehandlers/FreshDeviceHandlerBase.h @@ -78,7 +78,7 @@ class FreshDeviceHandlerBase : public SystemObject, * 1. Performing periodic polling of the physical device in NORMAL mode. This is usually required * to poll housekeeping data from the device periodically. * 2. Handle on-going mode transitions if the mode transitions can only be handled asynchronously. - * This might also involve communication with the phsyical device and power switch + * This might also involve communication with the physical device and power switch * handling/polling for transition to OFF or ON/NORMAL. * 3. Perform other periodic tasks which always need to be done irrespective of mode. */ @@ -132,13 +132,17 @@ class FreshDeviceHandlerBase : public SystemObject, // Mode Helpers. virtual void modeChanged(Mode_t mode, Submode_t submode); + /** + * This method is called when a mode message to set a new mode is received. + * * 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 roughly * 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; + virtual void setMode(Mode_t newMode, Submode_t newSubmode); virtual void setMode(Mode_t newMode); void getMode(Mode_t* mode, Submode_t* submode) override; @@ -173,7 +177,7 @@ class FreshDeviceHandlerBase : public SystemObject, ReturnValue_t setHealth(HealthState health) override; /** - * This is called when an ActionMessage to execute an action is received. + * This is called when an ActionMessage is received to execute it. * @param actionId * @param commandedBy * @param data -- 2.43.0