204 lines
8.2 KiB
C++
204 lines
8.2 KiB
C++
#ifndef FSFW_DATAPOOLLOCAL_LOCALPOOLVARIABLE_H_
|
|
#define FSFW_DATAPOOLLOCAL_LOCALPOOLVARIABLE_H_
|
|
|
|
#include "LocalPoolObjectBase.h"
|
|
#include "HasLocalDataPoolIF.h"
|
|
#include "LocalDataPoolManager.h"
|
|
#include "AccessLocalPoolF.h"
|
|
#include "internal/LocalDpManagerAttorney.h"
|
|
|
|
#include "../datapool/PoolVariableIF.h"
|
|
#include "../datapool/DataSetIF.h"
|
|
#include "../serviceinterface/ServiceInterface.h"
|
|
#include "../objectmanager/ObjectManagerIF.h"
|
|
#include "../serialize/SerializeAdapter.h"
|
|
|
|
/**
|
|
* @brief Local Pool Variable class which is used to access the local pools.
|
|
* @details
|
|
* This class is not stored in the map. Instead, it is used to access
|
|
* the pool entries by using a pointer to the map storing the pool
|
|
* entries. It can also be used to organize these pool entries into data sets.
|
|
*
|
|
* @tparam T The template parameter sets the type of the variable. Currently,
|
|
* all plain data types are supported, but in principle any type is possible.
|
|
* @ingroup data_pool
|
|
*/
|
|
template<typename T>
|
|
class LocalPoolVariable: public LocalPoolObjectBase {
|
|
public:
|
|
//! Default ctor is forbidden.
|
|
LocalPoolVariable() = delete;
|
|
|
|
/**
|
|
* This constructor is used by the data creators to have pool variable
|
|
* instances which can also be stored in datasets.
|
|
*
|
|
* It does not fetch the current value from the data pool, which
|
|
* has to be done by calling the read() operation.
|
|
* Datasets can be used to access multiple local pool entries in an
|
|
* efficient way. A pointer to a dataset can be passed to register
|
|
* the pool variable in that dataset directly.
|
|
* @param poolId ID of the local pool entry.
|
|
* @param hkOwner Pointer of the owner. This will generally be the calling
|
|
* class itself which passes "this".
|
|
* @param dataSet The data set in which the variable shall register itself.
|
|
* If nullptr, the variable is not registered.
|
|
* @param setReadWriteMode Specify the read-write mode of the pool variable.
|
|
*/
|
|
LocalPoolVariable(HasLocalDataPoolIF* hkOwner, lp_id_t poolId,
|
|
DataSetIF* dataSet = nullptr,
|
|
pool_rwm_t setReadWriteMode = pool_rwm_t::VAR_READ_WRITE);
|
|
|
|
/**
|
|
* This constructor is used by data users like controllers to have
|
|
* access to the local pool variables of data creators by supplying
|
|
* the respective creator object ID.
|
|
*
|
|
* It does not fetch the current value from the data pool, which
|
|
* has to be done by calling the read() operation.
|
|
* Datasets can be used to access multiple local pool entries in an
|
|
* efficient way. A pointer to a dataset can be passed to register
|
|
* the pool variable in that dataset directly.
|
|
* @param poolId ID of the local pool entry.
|
|
* @param hkOwner object ID of the pool owner.
|
|
* @param dataSet The data set in which the variable shall register itself.
|
|
* If nullptr, the variable is not registered.
|
|
* @param setReadWriteMode Specify the read-write mode of the pool variable.
|
|
*
|
|
*/
|
|
LocalPoolVariable(object_id_t poolOwner, lp_id_t poolId,
|
|
DataSetIF* dataSet = nullptr,
|
|
pool_rwm_t setReadWriteMode = pool_rwm_t::VAR_READ_WRITE);
|
|
/**
|
|
* Variation which takes the global unique identifier of a pool variable.
|
|
* @param globalPoolId
|
|
* @param dataSet
|
|
* @param setReadWriteMode
|
|
*/
|
|
LocalPoolVariable(gp_id_t globalPoolId, DataSetIF* dataSet = nullptr,
|
|
pool_rwm_t setReadWriteMode = pool_rwm_t::VAR_READ_WRITE);
|
|
|
|
virtual~ LocalPoolVariable() {};
|
|
|
|
/**
|
|
* @brief This is the local copy of the data pool entry.
|
|
* @details The user can work on this attribute
|
|
* just like he would on a simple local variable.
|
|
*/
|
|
T value = 0;
|
|
|
|
ReturnValue_t serialize(uint8_t** buffer, size_t* size, size_t maxSize,
|
|
SerializeIF::Endianness streamEndianness) const override;
|
|
virtual size_t getSerializedSize() const override;
|
|
virtual ReturnValue_t deSerialize(const uint8_t** buffer, size_t* size,
|
|
SerializeIF::Endianness streamEndianness) override;
|
|
|
|
/**
|
|
* @brief This is a call to read the array's values
|
|
* from the global data pool.
|
|
* @details
|
|
* When executed, this operation tries to fetch the pool entry with matching
|
|
* data pool id from the data pool and copies all array values and the valid
|
|
* information to its local attributes.
|
|
* In case of a failure (wrong type, size or pool id not found), the
|
|
* variable is set to zero and invalid.
|
|
* The read call is protected with a lock.
|
|
* It is recommended to use DataSets to read and commit multiple variables
|
|
* at once to avoid the overhead of unnecessary lock und unlock operations.
|
|
*
|
|
*/
|
|
ReturnValue_t read(MutexIF::TimeoutType timeoutType =
|
|
MutexIF::TimeoutType::WAITING,
|
|
uint32_t timeoutMs = 20) override;
|
|
/**
|
|
* @brief The commit call copies the array values back to the data pool.
|
|
* @details
|
|
* It checks type and size, as well as if the variable is writable. If so,
|
|
* the value is copied and the local valid flag is written back as well.
|
|
* The read call is protected with a lock.
|
|
* It is recommended to use DataSets to read and commit multiple variables
|
|
* at once to avoid the overhead of unnecessary lock und unlock operations.
|
|
*/
|
|
ReturnValue_t commit(MutexIF::TimeoutType timeoutType =
|
|
MutexIF::TimeoutType::WAITING,
|
|
uint32_t timeoutMs = 20) override;
|
|
|
|
/**
|
|
* @brief This commit function can be used to set the pool variable valid
|
|
* as well.
|
|
* @param setValid
|
|
* @param timeoutType
|
|
* @param timeoutMs
|
|
* @return
|
|
*/
|
|
ReturnValue_t commit(bool setValid, MutexIF::TimeoutType timeoutType =
|
|
MutexIF::TimeoutType::WAITING,
|
|
uint32_t timeoutMs = 20);
|
|
|
|
LocalPoolVariable<T> &operator=(const T& newValue);
|
|
LocalPoolVariable<T> &operator=(const LocalPoolVariable<T>& newPoolVariable);
|
|
|
|
//! Explicit type conversion operator. Allows casting the class to
|
|
//! its template type to perform operations on value.
|
|
explicit operator T() const;
|
|
|
|
bool operator==(const LocalPoolVariable<T>& other) const;
|
|
bool operator==(const T& other) const;
|
|
|
|
bool operator!=(const LocalPoolVariable<T>& other) const;
|
|
bool operator!=(const T& other) const;
|
|
|
|
bool operator<(const LocalPoolVariable<T>& other) const;
|
|
bool operator<(const T& other) const;
|
|
|
|
bool operator>(const LocalPoolVariable<T>& other) const;
|
|
bool operator>(const T& other) const;
|
|
|
|
protected:
|
|
/**
|
|
* @brief Like #read, but without a lock protection of the global pool.
|
|
* @details
|
|
* The operation does NOT provide any mutual exclusive protection by itself.
|
|
* This can be used if the lock is handled externally to avoid the overhead
|
|
* of consecutive lock und unlock operations.
|
|
* Declared protected to discourage free public usage.
|
|
*/
|
|
ReturnValue_t readWithoutLock() override;
|
|
/**
|
|
* @brief Like #commit, but without a lock protection of the global pool.
|
|
* @details
|
|
* The operation does NOT provide any mutual exclusive protection by itself.
|
|
* This can be used if the lock is handled externally to avoid the overhead
|
|
* of consecutive lock und unlock operations.
|
|
* Declared protected to discourage free public usage.
|
|
*/
|
|
ReturnValue_t commitWithoutLock() override;
|
|
|
|
#if FSFW_CPP_OSTREAM_ENABLED == 1
|
|
// std::ostream is the type for object std::cout
|
|
template <typename U>
|
|
friend std::ostream& operator<< (std::ostream &out,
|
|
const LocalPoolVariable<U> &var);
|
|
#endif
|
|
};
|
|
|
|
#include "LocalPoolVariable.tpp"
|
|
|
|
template<class T>
|
|
using lp_var_t = LocalPoolVariable<T>;
|
|
|
|
using lp_bool_t = LocalPoolVariable<uint8_t>;
|
|
using lp_uint8_t = LocalPoolVariable<uint8_t>;
|
|
using lp_uint16_t = LocalPoolVariable<uint16_t>;
|
|
using lp_uint32_t = LocalPoolVariable<uint32_t>;
|
|
using lp_uint64_t = LocalPoolVariable<uint64_t>;
|
|
using lp_int8_t = LocalPoolVariable<int8_t>;
|
|
using lp_int16_t = LocalPoolVariable<int16_t>;
|
|
using lp_int32_t = LocalPoolVariable<int32_t>;
|
|
using lp_int64_t = LocalPoolVariable<int64_t>;
|
|
using lp_float_t = LocalPoolVariable<float>;
|
|
using lp_double_t = LocalPoolVariable<double>;
|
|
|
|
#endif /* FSFW_DATAPOOLLOCAL_LOCALPOOLVARIABLE_H_ */
|