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

more docs

Browse Source
This commit is contained in:
Robin Müller 2022-03-22 16:10:20 +01:00
parent 6dd6f28db0
commit 2823420c46
No known key found for this signature in database
GPG Key ID: 71B58F8A3CDFA9AC
2 changed files with 12 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
src/fsfw/subsystem/Subsystem.h
View File

@ -12,8 +12,12 @@
#include "modes/ModeDefinitions.h" #include "modes/ModeDefinitions.h"
/** /**
* @brief TODO: documentation missing * @brief This class extends the SubsystemBase to perform the management of mode tables
* and mode sequences
* @details * @details
* This class is able to use mode tables and sequences to command all its children into the
* right mode. Fallback sequences can be used to handle failed transitions or have a fallback
* in case a component can't keep its current mode.
*/ */
class Subsystem : public SubsystemBase, public HasModeSequenceIF { class Subsystem : public SubsystemBase, public HasModeSequenceIF {
public: public:

8
src/fsfw/subsystem/SubsystemBase.h
View File

@ -17,7 +17,12 @@
* @defgroup subsystems Subsystem Objects * @defgroup subsystems Subsystem Objects
* All Subsystem and Assemblies can derive from this class. It contains helper classes to * All Subsystem and Assemblies can derive from this class. It contains helper classes to
* perform mode and health handling, which allows OBSW developers to build a mode tree for * perform mode and health handling, which allows OBSW developers to build a mode tree for
* the whole satellite * the whole satellite.
*
* Aside from setting up a mode tree and being able to executing mode tables, this class does not
* provide an implementation on what to do with the features. To build a mode tree, helper classes
* like the #AssemblyBase or the #Subsystem class extend and use the functionality of the base
* class.
*/ */
class SubsystemBase : public SystemObject, class SubsystemBase : public SystemObject,
public HasModesIF, public HasModesIF,
@ -98,6 +103,7 @@ class SubsystemBase : public SystemObject,
Submode_t targetSubmode); Submode_t targetSubmode);
/** /**
* This function takes care of sending all according mode commands specified inside a mode table.
* We need to know the target Submode, as children are able to inherit the submode * We need to know the target Submode, as children are able to inherit the submode
* Still, we have a default for all child implementations which do not use submode inheritance * Still, we have a default for all child implementations which do not use submode inheritance
*/ */