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

doc update

Browse Source
This commit is contained in:
Robin Müller 2021-01-11 16:38:25 +01:00
parent 5e251705f6
commit ef9ad60ba8
1 changed files with 10 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
datapoollocal/LocalPoolDataSetBase.h
View File

@ -58,8 +58,10 @@ public:
/** /**
* @brief Constructor for users of the local pool data, which need * @brief Constructor for users of the local pool data, which need
* to access data created by one HK manager. * to access data created by one (!) HK manager.
* @details * @details
* Unlike the first constructor, no component for periodic handling
* will be initiated.
* @param sid Unique identifier of dataset consisting of object ID and * @param sid Unique identifier of dataset consisting of object ID and
* set ID. * set ID.
* @param registeredVariablesArray * @param registeredVariablesArray
@ -69,9 +71,13 @@ public:
const size_t maxNumberOfVariables); const size_t maxNumberOfVariables);
/** /**
* Simple constructor, if the dataset is not the owner by * @brief Simple constructor, if the dataset is not the owner by
* a class with a HK manager. This function should also be called by * a class with a HK manager.
* classes which needs to access pool variables from different creators. * @details
* This constructor won't create components required for periodic handling
* and it also won't try to deduce the HK manager because no SID is
* supplied. This function should therefore be called by classes which need
* to access pool variables from different creators.
* *
* If the class is intended to access pool variables from different * If the class is intended to access pool variables from different
* creators, the third argument should be set to true. The mutex * creators, the third argument should be set to true. The mutex