fsfw/datapool/PoolVariableIF.h

66 lines
2.0 KiB
C
Raw Normal View History

2020-09-06 15:23:38 +02:00
#ifndef FSFW_DATAPOOL_POOLVARIABLEIF_H_
#define FSFW_DATAPOOL_POOLVARIABLEIF_H_
2020-08-13 20:53:35 +02:00
#include "../returnvalues/HasReturnvaluesIF.h"
#include "../serialize/SerializeIF.h"
#include "ReadCommitIF.h"
/**
2020-09-06 15:23:38 +02:00
* @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
* variables. To ensure a common state of a set of variables needed in a
* function, these local pool variables again are managed by other classes,
* like the DataSet classes. This interface provides unified access to
* local pool variables for such manager classes.
* @author Bastian Baetz
* @ingroup data_pool
*/
class PoolVariableIF : public SerializeIF,
public ReadCommitIF {
2020-09-06 15:23:38 +02:00
friend class PoolDataSetBase;
friend class LocalPoolDataSetBase;
public:
2020-09-06 15:23:38 +02:00
static constexpr uint8_t INTERFACE_ID = CLASS_ID::POOL_VARIABLE_IF;
static constexpr ReturnValue_t INVALID_READ_WRITE_MODE = MAKE_RETURN_CODE(0xA0);
static constexpr bool VALID = 1;
static constexpr bool INVALID = 0;
static constexpr uint32_t NO_PARAMETER = 0xffffffff;
enum ReadWriteMode_t {
VAR_READ, VAR_WRITE, VAR_READ_WRITE
};
/**
2020-09-06 15:23:38 +02:00
* @brief This is an empty virtual destructor,
* as it is proposed for C++ interfaces.
*/
2020-09-06 15:23:38 +02:00
virtual ~PoolVariableIF() {}
/**
2020-09-06 15:23:38 +02:00
* @brief This method returns if the variable is write-only,
* read-write or read-only.
*/
virtual ReadWriteMode_t getReadWriteMode() const = 0;
/**
2020-09-06 15:23:38 +02:00
* @brief This operation shall return the data pool id of the variable.
*/
virtual uint32_t getDataPoolId() const = 0;
/**
2020-09-06 15:23:38 +02:00
* @brief With this call, the valid information of the
* variable is returned.
*/
virtual bool isValid() const = 0;
/**
2020-09-06 15:23:38 +02:00
* @brief With this call, the valid information of the variable is set.
*/
2020-09-06 15:23:38 +02:00
virtual void setValid(bool validity) = 0;
};
2020-09-06 15:23:38 +02:00
using pool_rwm_t = PoolVariableIF::ReadWriteMode_t;
#endif /* FSFW_DATAPOOL_POOLVARIABLEIF_H_ */