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

comment format

Browse Source
This commit is contained in:
Robin Müller 2020-05-11 17:20:10 +02:00
parent fc4f9156b9
commit eb376318c3
1 changed files with 30 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

50
devicehandlers/FixedSlotSequence.h
View File

@ -3,7 +3,6 @@
#include <framework/devicehandlers/FixedSequenceSlot.h> #include <framework/devicehandlers/FixedSequenceSlot.h>
#include <framework/objectmanager/SystemObject.h> #include <framework/objectmanager/SystemObject.h>
#include <list>
#include <set> #include <set>
using SlotList = std::multiset<FixedSequenceSlot>; using SlotList = std::multiset<FixedSequenceSlot>;
@ -72,9 +71,10 @@ public:
bool slotFollowsImmediately(); bool slotFollowsImmediately();
/** /**
* \brief This method returns the time until the next software component is invoked. * @brief This method returns the time until the next software
* component is invoked.
* *
* \details * @details
* This method is vitally important for the operation of the PST. * This method is vitally important for the operation of the PST.
* By fetching the polling time of the current slot and that of the * By fetching the polling time of the current slot and that of the
* next one (or the first one, if the list end is reached) * next one (or the first one, if the list end is reached)
@ -86,11 +86,15 @@ public:
uint32_t getIntervalToNextSlotMs(); uint32_t getIntervalToNextSlotMs();
/** /**
* \brief This method returns the time difference between the current slot and the previous slot * @brief This method returns the time difference between the current
* slot and the previous slot
* *
* \details This method is vitally important for the operation of the PST. By fetching the polling time * @details
* of the current slot and that of the prevous one (or the last one, if the slot is the first one) * This method is vitally important for the operation of the PST.
* it calculates and returns the interval in milliseconds that the handler execution shall be delayed. * By fetching the polling time of the current slot and that of the previous
* one (or the last one, if the slot is the first one) it calculates and
* returns the interval in milliseconds that the handler execution shall
* be delayed.
*/ */
uint32_t getIntervalToPreviousSlotMs(); uint32_t getIntervalToPreviousSlotMs();
@ -100,20 +104,24 @@ public:
uint32_t getLengthMs() const; uint32_t getLengthMs() const;
/** /**
* \brief The method to execute the device handler entered in the current PollingSlot object. * @brief The method to execute the device handler entered in the current
* PollingSlot object.
* *
* \details Within this method the device handler object to be executed is chosen by looking up the * @details
* handler address of the current slot in the handlerMap. Either the device handler's * Within this method the device handler object to be executed is chosen by
* talkToInterface or its listenToInterface method is invoked, depending on the isTalking flag * looking up the handler address of the current slot in the handlerMap.
* of the polling slot. After execution the iterator current is increased or, by reaching the * Either the device handler's talkToInterface or its listenToInterface
* end of slotList, reset to the beginning. * method is invoked, depending on the isTalking flag of the polling slot.
* After execution the iterator current is increased or, by reaching the
* end of slotList, reset to the beginning.
*/ */
void executeAndAdvance(); void executeAndAdvance();
/** /**
* @brief An iterator that indicates the current polling slot to execute. * @brief An iterator that indicates the current polling slot to execute.
* *
* @details This is an iterator for slotList and always points to the polling slot which is executed next. * @details This is an iterator for slotList and always points to the
* polling slot which is executed next.
*/ */
SlotListIter current; SlotListIter current;
@ -127,13 +135,15 @@ public:
protected: protected:
/** /**
* @brief This list contains all PollingSlot objects, defining order and execution time of the * @brief This list contains all PollingSlot objects, defining order and
* device handler objects. * execution time of the device handler objects.
* *
* @details The slot list is a std:list object that contains all created PollingSlot instances. * @details
* They are NOT ordered automatically, so by adding entries, the correct order needs to be ensured. * The slot list is a std:list object that contains all created
* By iterating through this list the polling sequence is executed. Two entries with identical * PollingSlot instances. They are NOT ordered automatically, so by
* polling times are executed immediately one after another. * adding entries, the correct order needs to be ensured. By iterating
* through this list the polling sequence is executed. Two entries with
* identical polling times are executed immediately one after another.
*/ */
SlotList slotList; SlotList slotList;