KSat/fsfw
15
4
Fork 0
forked from fsfw/fsfw
Code Issues Pull Requests 1 Releases Wiki Activity

some FDHB docs improvements

Browse Source
This commit is contained in:
Robin Müller 2024-12-11 13:54:16 +01:00
parent 2165f8ead8
commit d77dbe44c6
Signed by: muellerr
GPG Key ID: A649FB78196E3849
1 changed files with 6 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
src/fsfw/devicehandlers/FreshDeviceHandlerBase.h
View File

@ -78,7 +78,7 @@ class FreshDeviceHandlerBase : public SystemObject,
* 1. Performing periodic polling of the physical device in NORMAL mode. This is usually required * 1. Performing periodic polling of the physical device in NORMAL mode. This is usually required
* to poll housekeeping data from the device periodically. * to poll housekeeping data from the device periodically.
* 2. Handle on-going mode transitions if the mode transitions can only be handled asynchronously. * 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. * handling/polling for transition to OFF or ON/NORMAL.
* 3. Perform other periodic tasks which always need to be done irrespective of mode. * 3. Perform other periodic tasks which always need to be done irrespective of mode.
*/ */
@ -132,13 +132,17 @@ class FreshDeviceHandlerBase : public SystemObject,
// Mode Helpers. // Mode Helpers.
virtual void modeChanged(Mode_t mode, Submode_t submode); 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 * 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 * 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 * the same functionality of this function, when all the steps have been taken to reach the
* new mode. * new mode.
*/ */
void startTransition(Mode_t mode, Submode_t submode) override; void startTransition(Mode_t mode, Submode_t submode) override;
virtual void setMode(Mode_t newMode, Submode_t newSubmode); virtual void setMode(Mode_t newMode, Submode_t newSubmode);
virtual void setMode(Mode_t newMode); virtual void setMode(Mode_t newMode);
void getMode(Mode_t* mode, Submode_t* submode) override; void getMode(Mode_t* mode, Submode_t* submode) override;
@ -173,7 +177,7 @@ class FreshDeviceHandlerBase : public SystemObject,
ReturnValue_t setHealth(HealthState health) override; 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 actionId
* @param commandedBy * @param commandedBy
* @param data * @param data