Improve readability of SubsystemBase::executeTable #49

mspahr · 2025-02-16T17:29:38+01:00

mspahr commented

2025-02-16 17:29:38 +01:00

The logic in SubsystemBase::executeTable handles the sending of mode commands to the respective children of some objects; and this functionality is (among other things) based on the health state of the respective child.
To determine the health state, the fsfw function ManagesHealthIF::isFaulty() was used, see here.

However, the name of this function is misleading, as it returns true if the health state is FAULTY or PERMANENT_FAULTY or NEEDS_RECOVERY.

This change aims to improve the readability of the code without modifying the function.

The logic in `SubsystemBase::executeTable` handles the sending of mode commands to the respective children of some objects; and this functionality is (among other things) based on the health state of the respective child. To determine the health state, the fsfw function `ManagesHealthIF::isFaulty()` was used, [see here](https://egit.irs.uni-stuttgart.de/KSat/fsfw/src/commit/735e341aabd6fa06c9cd4121f96b45a13ade6331/src/fsfw/health/ManagesHealthIF.h#L34). However, the name of this function is misleading, as it returns true if the health state is FAULTY or PERMANENT_FAULTY or NEEDS_RECOVERY. This change aims to improve the readability of the code **without** modifying the function.

mspahr added 1 commit 2025-02-16 17:29:38 +01:00

Re-write the logic in executeTable() to improve the readabilty of the code. This gets rid of the usage of isFaulty() (which is misleading), and removes nexted if-statements 6efb2641a7

mspahr requested review from muellerr 2025-02-16 17:30:02 +01:00

muellerr commented

2025-02-19 11:25:35 +01:00

good old switch case. Thanks for improving this, this was really confusing