KSat/fsfw
19
6
Fork 0
forked from fsfw/fsfw
Code Issues Pull Requests Releases Wiki Activity

improved documentation signigicantly

Browse Source
This commit is contained in:
Robin Müller
2020-06-07 02:22:18 +02:00
parent d0b218c18e
commit fe5b50d885
12 changed files with 118 additions and 87 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
datapool/PoolVariableIF.h
View File

@ -1,12 +1,12 @@
#ifndef POOLVARIABLEIF_H_
#define POOLVARIABLEIF_H_
#ifndef FRAMEWORK_DATAPOOL_POOLVARIABLEIF_H_
#define FRAMEWORK_DATAPOOL_POOLVARIABLEIF_H_
#include <framework/returnvalues/HasReturnvaluesIF.h>
#include <framework/serialize/SerializeIF.h>
/**
* @brief This interface is used to control data pool variable representations.
* @brief This interface is used to control data pool
* variable representations.
* @details
* To securely handle data pool variables, all pool entries are locally
* managed by data pool variable access classes, which are called pool
@ -39,7 +39,8 @@ public:
*/
virtual ~PoolVariableIF() {}
/**
* @brief This method returns if the variable is write-only, read-write or read-only.
* @brief This method returns if the variable is write-only,
* read-write or read-only.
*/
virtual ReadWriteMode_t getReadWriteMode() const = 0;
/**
@ -47,7 +48,8 @@ public:
*/
virtual uint32_t getDataPoolId() const = 0;
/**
* @brief With this call, the valid information of the variable is returned.
* @brief With this call, the valid information of the
* variable is returned.
*/
virtual bool isValid() const = 0;
/**