fsfw/datapool/PoolEntry.h

138 lines
4.4 KiB
C
Raw Normal View History

2020-09-06 15:23:38 +02:00
#ifndef FSFW_DATAPOOL_POOLENTRY_H_
#define FSFW_DATAPOOL_POOLENTRY_H_
2020-08-13 20:53:35 +02:00
#include "PoolEntryIF.h"
2020-06-05 13:43:06 +02:00
2020-05-08 14:38:10 +02:00
#include <initializer_list>
2020-05-11 16:53:16 +02:00
#include <type_traits>
2020-06-05 13:43:06 +02:00
#include <cstddef>
/**
2020-05-08 14:38:10 +02:00
* @brief This is a small helper class that defines a single data pool entry.
* @details
* The helper is used to store all information together with the data as a
2020-06-05 13:43:06 +02:00
* single data pool entry. The content's type is defined by the template
* argument.
*
2020-06-05 13:43:06 +02:00
* It is prepared for use with plain old data types, but may be
* extended to complex types if necessary. It can be initialized with a
* certain value, size and validity flag.
*
2020-06-05 13:43:06 +02:00
* It holds a pointer to the real data and offers methods to access this data
* and to acquire additional information (such as validity and array/byte size).
* It is NOT intended to be used outside DataPool implementations as it performs
* dynamic memory allocation.
*
* @ingroup data_pool
*/
template <typename T>
class PoolEntry : public PoolEntryIF {
public:
2020-05-11 16:53:16 +02:00
static_assert(not std::is_same<T, bool>::value,
2020-06-05 13:43:06 +02:00
"Do not use boolean for the PoolEntry type, use uint8_t "
"instead! The ECSS standard defines a boolean as a one bit "
"field. Therefore it is preferred to store a boolean as an "
"uint8_t");
/**
2020-05-08 14:38:10 +02:00
* @brief In the classe's constructor, space is allocated on the heap and
2021-01-13 12:02:23 +01:00
* potential initialization values are copied to that space.
2020-06-05 13:43:06 +02:00
* @details
* Not passing any arguments will initialize an non-array pool entry
2021-01-13 12:02:23 +01:00
* with an initial invalid state and the value 0.
* Please note that if an initializer list is passed, the length of the
* initializer list needs to be correct for vector entries because
* required allocated space will be deduced from the initializer list length
* and the pool entry type.
2020-06-05 13:43:06 +02:00
* @param initValue
2021-01-13 12:02:23 +01:00
* Initializer list with values to initialize with, for example {0, 0} to
* initialize the a pool entry of a vector with two entries to 0.
2020-06-05 13:43:06 +02:00
* @param setValid
* Sets the initialization flag. It is invalid by default.
*/
2021-01-13 12:02:23 +01:00
PoolEntry(std::initializer_list<T> initValue = {0}, bool setValid = false);
2020-05-08 14:38:10 +02:00
/**
* @brief In the classe's constructor, space is allocated on the heap and
* potential init values are copied to that space.
2020-06-05 13:43:06 +02:00
* @param initValue
* A pointer to the single value or array that holds the init value.
* With the default value (nullptr), the entry is initalized with all 0.
* @param setLength
* Defines the array length of this entry.
* @param setValid
* Sets the initialization flag. It is invalid by default.
2020-05-08 14:38:10 +02:00
*/
2020-06-05 13:43:06 +02:00
PoolEntry(T* initValue, uint8_t setLength = 1, bool setValid = false);
2021-01-13 12:02:23 +01:00
//! Explicitely deleted copy ctor, copying is not allowed.
2020-06-05 13:43:06 +02:00
PoolEntry(const PoolEntry&) = delete;
2021-01-13 12:02:23 +01:00
//! Explicitely deleted copy assignment, copying is not allowed.
2020-06-05 13:43:06 +02:00
PoolEntry& operator=(const PoolEntry&) = delete;
2020-05-08 14:38:10 +02:00
/**
2020-06-05 13:43:06 +02:00
* @brief The allocated memory for the variable is freed
* in the destructor.
* @details
* As the data pool is global, this dtor is only called on program exit.
* PoolEntries shall never be copied, as a copy might delete the variable
* on the heap.
*/
~PoolEntry();
2020-06-05 13:43:06 +02:00
/**
2021-01-13 12:02:23 +01:00
* Return typed pointer to start of data.
* @return
*/
2021-01-13 12:02:23 +01:00
T* getDataPtr();
/**
2020-05-08 14:38:10 +02:00
* @brief getSize returns the array size of the entry.
2021-01-13 12:02:23 +01:00
* @details
* For non-array pool entries return type size, for vector entries
* return type size times the number of entries.
*/
uint8_t getSize();
/**
2020-05-08 14:38:10 +02:00
* @brief This operation returns the size in bytes.
* @details The size is calculated by sizeof(type) * array_size.
*/
uint16_t getByteSize();
/**
2020-05-08 14:38:10 +02:00
* @brief This operation returns a the address pointer casted to void*.
*/
void* getRawData();
/**
2020-06-05 13:43:06 +02:00
* @brief This method allows to set the valid information
* of the pool entry.
*/
2020-06-05 13:43:06 +02:00
void setValid( bool isValid );
/**
2020-06-05 13:43:06 +02:00
* @brief This method allows to get the valid information
* of the pool entry.
*/
2020-06-05 13:43:06 +02:00
bool getValid();
/**
2020-05-08 14:38:10 +02:00
* @brief This is a debug method that prints all values and the valid
* information to the screen. It prints all array entries in a row.
*/
void print();
Type getType();
2021-01-13 12:02:23 +01:00
private:
/**
* @brief This attribute stores the length information.
*/
uint8_t length;
/**
* @brief Here, the validity information for a variable is stored.
* Every entry (single variable or vector) has one valid flag.
*/
uint8_t valid;
/**
* @brief This is the address pointing to the allocated memory.
*/
T* address;
};
2020-09-06 15:23:38 +02:00
#endif /* FSFW_DATAPOOL_POOLENTRY_H_ */