140 lines
4.9 KiB
C++
140 lines
4.9 KiB
C++
#ifndef FSFW_DATAPOOLLOCAL_HASLOCALDATAPOOLIF_H_
|
|
#define FSFW_DATAPOOLLOCAL_HASLOCALDATAPOOLIF_H_
|
|
|
|
#include "locPoolDefinitions.h"
|
|
|
|
#include "../datapool/PoolEntryIF.h"
|
|
#include "../ipc/MessageQueueSenderIF.h"
|
|
#include "../housekeeping/HousekeepingMessage.h"
|
|
|
|
#include <map>
|
|
|
|
class LocalDataPoolManager;
|
|
class LocalPoolDataSetBase;
|
|
class LocalPoolObjectBase;
|
|
|
|
using LocalDataPool = std::map<lp_id_t, PoolEntryIF*>;
|
|
using LocalDataPoolMapIter = LocalDataPool::iterator;
|
|
|
|
/**
|
|
* @brief This interface is implemented by classes which posses a local
|
|
* data pool (not the managing class). It defines the relationship
|
|
* between the local data pool owner and the LocalDataPoolManager.
|
|
* @details
|
|
* Any class implementing this interface shall also have a LocalDataPoolManager
|
|
* member class which contains the actual pool data structure
|
|
* and exposes the public interface for it.
|
|
* This is required because the pool entries are templates, which makes
|
|
* specifying an interface rather difficult. The local data pool can be
|
|
* accessed by using the LocalPoolVariable, LocalPoolVector or LocalDataSet
|
|
* classes.
|
|
*
|
|
* Architectural Note:
|
|
* This could be circumvented by using a wrapper/accessor function or
|
|
* implementing the templated function in this interface..
|
|
* The first solution sounds better than the second but
|
|
* the LocalPoolVariable classes are templates as well, so this just shifts
|
|
* the problem somewhere else. Interfaces are nice, but the most
|
|
* pragmatic solution I found was to offer the client the full interface
|
|
* of the LocalDataPoolManager.
|
|
*/
|
|
class HasLocalDataPoolIF {
|
|
public:
|
|
virtual~ HasLocalDataPoolIF() {};
|
|
|
|
static constexpr uint8_t INTERFACE_ID = CLASS_ID::LOCAL_POOL_OWNER_IF;
|
|
|
|
static constexpr ReturnValue_t POOL_ENTRY_NOT_FOUND = MAKE_RETURN_CODE(0x00);
|
|
static constexpr ReturnValue_t POOL_ENTRY_TYPE_CONFLICT = MAKE_RETURN_CODE(0x01);
|
|
|
|
static constexpr uint32_t INVALID_LPID = localpool::INVALID_LPID;
|
|
|
|
virtual object_id_t getObjectId() const = 0;
|
|
|
|
/** Command queue for housekeeping messages. */
|
|
virtual MessageQueueId_t getCommandQueue() const = 0;
|
|
|
|
/**
|
|
* Is used by pool owner to initialize the pool map once
|
|
* The manager instance shall also be passed to this function.
|
|
* It can be used to subscribe for periodic packets for for updates.
|
|
*/
|
|
virtual ReturnValue_t initializeLocalDataPool(
|
|
LocalDataPool& localDataPoolMap,
|
|
LocalDataPoolManager& poolManager) = 0;
|
|
|
|
/** Can be used to get a handle to the local data pool manager. */
|
|
virtual LocalDataPoolManager* getHkManagerHandle() = 0;
|
|
|
|
/**
|
|
* Returns the minimum sampling frequency in milliseconds, which will
|
|
* usually be the period the pool owner performs its periodic operation.
|
|
* @return
|
|
*/
|
|
virtual uint32_t getPeriodicOperationFrequency() const = 0;
|
|
|
|
/**
|
|
* This function is used by the pool manager to get a valid dataset
|
|
* from a SID
|
|
* @param sid Corresponding structure ID
|
|
* @return
|
|
*/
|
|
virtual LocalPoolDataSetBase* getDataSetHandle(sid_t sid) = 0;
|
|
|
|
/**
|
|
* Similar to the function above, but used to get a local pool variable
|
|
* handle. This is only needed for update notifications, so it is not
|
|
* defined as abstract.
|
|
* @param localPoolId
|
|
* @return
|
|
*/
|
|
virtual LocalPoolObjectBase* getPoolObjectHandle(lp_id_t localPoolId) {
|
|
sif::warning << "HasLocalDataPoolIF::getPoolObjectHandle: Not overriden"
|
|
<< ". Returning nullptr!" << std::endl;
|
|
return nullptr;
|
|
}
|
|
|
|
/**
|
|
* @brief This function will be called by the manager if an update
|
|
* notification is received.
|
|
* @details
|
|
* Can be overriden by the child class to handle changed datasets.
|
|
* @param sid
|
|
* @param storeId If a snapshot was requested, data will be located inside
|
|
* the IPC store with this store ID.
|
|
*/
|
|
virtual void handleChangedDataset(sid_t sid,
|
|
store_address_t storeId = storeId::INVALID_STORE_ADDRESS) {
|
|
return;
|
|
}
|
|
|
|
/**
|
|
* @brief This function will be called by the manager if an update
|
|
* notification is received.
|
|
* @details
|
|
* Can be overriden by the child class to handle changed pool IDs.
|
|
* @param sid
|
|
* @param storeId If a snapshot was requested, data will be located inside
|
|
* the IPC store with this store ID.
|
|
*/
|
|
virtual void handleChangedPoolVariable(lp_id_t poolId,
|
|
store_address_t storeId = storeId::INVALID_STORE_ADDRESS) {
|
|
return;
|
|
}
|
|
|
|
/* These function can be implemented by pool owner, as they are required
|
|
* by the housekeeping message interface */
|
|
virtual ReturnValue_t addDataSet(sid_t sid) {
|
|
return HasReturnvaluesIF::RETURN_FAILED;
|
|
};
|
|
virtual ReturnValue_t removeDataSet(sid_t sid) {
|
|
return HasReturnvaluesIF::RETURN_FAILED;
|
|
};
|
|
virtual ReturnValue_t changeCollectionInterval(sid_t sid,
|
|
float newIntervalSeconds) {
|
|
return HasReturnvaluesIF::RETURN_FAILED;
|
|
};
|
|
};
|
|
|
|
#endif /* FSFW_DATAPOOLLOCAL_HASLOCALDATAPOOLIF_H_ */
|