esbo_ds/fsfw
3
0
Fork 0
forked from fsfw/fsfw
Code Issues Pull Requests Releases Wiki Activity

form and doc comments

Browse Source
This commit is contained in:
Robin Müller 2020-11-29 13:01:37 +01:00
parent b7fb1b42e6
commit 279df93cdf
1 changed files with 16 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
subsystem/Subsystem.h
View File

@ -10,6 +10,10 @@
#include "../container/SinglyLinkedList.h" #include "../container/SinglyLinkedList.h"
#include "../serialize/SerialArrayListAdapter.h" #include "../serialize/SerialArrayListAdapter.h"
/**
* @brief TODO: documentation missing
* @details
*/
class Subsystem: public SubsystemBase, public HasModeSequenceIF { class Subsystem: public SubsystemBase, public HasModeSequenceIF {
public: public:
static const uint8_t INTERFACE_ID = CLASS_ID::SUBSYSTEM; static const uint8_t INTERFACE_ID = CLASS_ID::SUBSYSTEM;
@ -31,8 +35,13 @@ public:
static const ReturnValue_t TARGET_TABLE_NOT_REACHED = MAKE_RETURN_CODE(0xA1); static const ReturnValue_t TARGET_TABLE_NOT_REACHED = MAKE_RETURN_CODE(0xA1);
static const ReturnValue_t TABLE_CHECK_FAILED = MAKE_RETURN_CODE(0xA2); static const ReturnValue_t TABLE_CHECK_FAILED = MAKE_RETURN_CODE(0xA2);
/**
* TODO: Doc for constructor
* @param setObjectId
* @param parent
* @param maxNumberOfSequences
* @param maxNumberOfTables
*/
Subsystem(object_id_t setObjectId, object_id_t parent, Subsystem(object_id_t setObjectId, object_id_t parent,
uint32_t maxNumberOfSequences, uint32_t maxNumberOfTables); uint32_t maxNumberOfSequences, uint32_t maxNumberOfTables);
virtual ~Subsystem(); virtual ~Subsystem();
@ -52,24 +61,20 @@ public:
virtual MessageQueueId_t getSequenceCommandQueue() const override; virtual MessageQueueId_t getSequenceCommandQueue() const override;
/** /**
* * @brief Checks whether a sequence, identified by a mode.
*
* IMPORTANT: Do not call on non existing sequence! Use existsSequence() first
*
* @param sequence * @param sequence
* @return * @return
*/ */
ReturnValue_t checkSequence(Mode_t sequence); ReturnValue_t checkSequence(Mode_t sequence);
/** /**
* * @brief Checks whether a sequence, identified by a mode list iterator
* * and a fallback sequence.
* IMPORTANT: Do not call on non existing sequence! Use existsSequence() first
*
* @param iter * @param iter
* @return * @return
*/ */
ReturnValue_t checkSequence(HybridIterator<ModeListEntry> iter, Mode_t fallbackSequence); ReturnValue_t checkSequence(HybridIterator<ModeListEntry> iter,
Mode_t fallbackSequence);
protected: protected:
struct EntryPointer { struct EntryPointer {
@ -125,8 +130,6 @@ protected:
HybridIterator<ModeListEntry> getCurrentTable(); HybridIterator<ModeListEntry> getCurrentTable();
// void startSequence(Mode_t sequence);
/** /**
* DO NOT USE ON NON EXISTING SEQUENCE * DO NOT USE ON NON EXISTING SEQUENCE
* *