134 lines
4.5 KiB
C++
134 lines
4.5 KiB
C++
#ifndef FRAMEWORK_DATAPOOLLOCAL_LOCALPOOLDATASETBASE_H_
|
|
#define FRAMEWORK_DATAPOOLLOCAL_LOCALPOOLDATASETBASE_H_
|
|
#include "../datapool/DataSetIF.h"
|
|
#include "../datapool/PoolDataSetBase.h"
|
|
#include "../datapoollocal/HasLocalDataPoolIF.h"
|
|
#include "../serialize/SerializeIF.h"
|
|
|
|
#include <vector>
|
|
|
|
class LocalDataPoolManager;
|
|
|
|
/**
|
|
* @brief The LocalDataSet class manages a set of locally checked out
|
|
* variables for local data pools
|
|
* @details
|
|
* This class manages a list, where a set of local variables (or pool variables)
|
|
* are registered. They are checked-out (i.e. their values are looked
|
|
* up and copied) with the read call. After the user finishes working with the
|
|
* pool variables, he can write back all variable values to the pool with
|
|
* the commit call. The data set manages locking and freeing the local data pools,
|
|
* to ensure thread-safety.
|
|
*
|
|
* An internal state manages usage of this class. Variables may only be
|
|
* registered before the read call is made, and the commit call only
|
|
* after the read call.
|
|
*
|
|
* If pool variables are writable and not committed until destruction
|
|
* of the set, the DataSet class automatically sets the valid flag in the
|
|
* data pool to invalid (without) changing the variable's value.
|
|
*
|
|
* @ingroup data_pool
|
|
*/
|
|
class LocalPoolDataSetBase: public PoolDataSetBase {
|
|
public:
|
|
/**
|
|
* @brief Constructor for the creator of local pool data.
|
|
*/
|
|
LocalPoolDataSetBase(HasLocalDataPoolIF *hkOwner,
|
|
uint32_t setId, PoolVariableIF** registeredVariablesArray,
|
|
const size_t maxNumberOfVariables);
|
|
|
|
/**
|
|
* @brief Constructor for users of local pool data. The passed pool
|
|
* owner should implement the HasHkPoolParametersIF.
|
|
* @details
|
|
* @param sid Unique identifier of dataset consisting of object ID and
|
|
* set ID.
|
|
* @param registeredVariablesArray
|
|
* @param maxNumberOfVariables
|
|
*/
|
|
LocalPoolDataSetBase(sid_t sid, PoolVariableIF** registeredVariablesArray,
|
|
const size_t maxNumberOfVariables);
|
|
|
|
/**
|
|
* @brief The destructor automatically manages writing the valid
|
|
* information of variables.
|
|
* @details
|
|
* In case the data set was read out, but not committed(indicated by state),
|
|
* the destructor parses all variables that are still registered to the set.
|
|
* For each, the valid flag in the data pool is set to "invalid".
|
|
*/
|
|
~LocalPoolDataSetBase();
|
|
|
|
void setValidityBufferGeneration(bool withValidityBuffer);
|
|
|
|
ReturnValue_t serialize(uint8_t** buffer, size_t* size, size_t maxSize,
|
|
SerializeIF::Endianness streamEndianness) const override;
|
|
ReturnValue_t deSerialize(const uint8_t** buffer, size_t *size,
|
|
SerializeIF::Endianness streamEndianness) override;
|
|
size_t getSerializedSize() const override;
|
|
|
|
/**
|
|
* Special version of the serilization function which appends a
|
|
* validity buffer at the end. Each bit of this validity buffer
|
|
* denotes whether the container data set entries are valid from left
|
|
* to right, MSB first.
|
|
* @param buffer
|
|
* @param size
|
|
* @param maxSize
|
|
* @param bigEndian
|
|
* @param withValidityBuffer
|
|
* @return
|
|
*/
|
|
ReturnValue_t serializeWithValidityBuffer(uint8_t** buffer,
|
|
size_t* size, size_t maxSize,
|
|
SerializeIF::Endianness streamEndianness) const;
|
|
ReturnValue_t deSerializeWithValidityBuffer(const uint8_t** buffer,
|
|
size_t *size, SerializeIF::Endianness streamEndianness);
|
|
ReturnValue_t serializeLocalPoolIds(uint8_t** buffer,
|
|
size_t* size, size_t maxSize,
|
|
SerializeIF::Endianness streamEndianness) const;
|
|
|
|
bool isValid() const override;
|
|
|
|
protected:
|
|
sid_t sid;
|
|
/**
|
|
* If the valid state of a dataset is always relevant to the whole
|
|
* data set we can use this flag.
|
|
*/
|
|
bool valid = false;
|
|
|
|
bool withValidityBuffer = true;
|
|
|
|
/**
|
|
* @brief This is a small helper function to facilitate locking
|
|
* the global data pool.
|
|
* @details
|
|
* It makes use of the lockDataPool method offered by the DataPool class.
|
|
*/
|
|
ReturnValue_t lockDataPool(uint32_t timeoutMs) override;
|
|
/**
|
|
* @brief This is a small helper function to facilitate
|
|
* unlocking the global data pool
|
|
* @details
|
|
* It makes use of the freeDataPoolLock method offered by the DataPool class.
|
|
*/
|
|
ReturnValue_t unlockDataPool() override;
|
|
|
|
LocalDataPoolManager* hkManager;
|
|
|
|
/**
|
|
* Set n-th bit of a byte, with n being the position from 0
|
|
* (most significant bit) to 7 (least significant bit)
|
|
*/
|
|
void bitSetter(uint8_t* byte, uint8_t position) const;
|
|
bool bitGetter(const uint8_t* byte, uint8_t position) const;
|
|
private:
|
|
|
|
|
|
};
|
|
|
|
#endif /* FRAMEWORK_DATAPOOLLOCAL_LOCALPOOLDATASETBASE_H_ */
|