fsfw/datapoollocal/HasLocalDataPoolIF.h

149 lines
5.4 KiB
C
Raw Normal View History

2020-10-01 12:05:24 +02:00
#ifndef FSFW_DATAPOOLLOCAL_HASLOCALDATAPOOLIF_H_
#define FSFW_DATAPOOLLOCAL_HASLOCALDATAPOOLIF_H_
#include <fsfw/datapoollocal/localPoolDefinitions.h>
2020-10-01 12:05:24 +02:00
#include "../datapool/PoolEntryIF.h"
2021-01-10 13:58:33 +01:00
#include "../serviceinterface/ServiceInterface.h"
2020-10-01 12:05:24 +02:00
#include "../ipc/MessageQueueSenderIF.h"
#include "../housekeeping/HousekeepingMessage.h"
#include <map>
class AccessPoolManagerIF;
class ProvidesDataPoolSubscriptionIF;
2020-10-01 12:05:24 +02:00
class LocalPoolDataSetBase;
2020-12-03 13:00:04 +01:00
class LocalPoolObjectBase;
class LocalDataPoolManager;
2020-10-01 12:05:24 +02:00
/**
2021-01-12 14:08:51 +01:00
* @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.
2020-10-01 12:05:24 +02:00
* @details
2021-01-12 14:08:51 +01:00
* 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.
2020-10-01 12:05:24 +02:00
*
* Architectural Note:
2021-01-12 14:08:51 +01:00
* 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.
2020-10-01 12:05:24 +02:00
*/
class HasLocalDataPoolIF {
2021-01-12 14:08:51 +01:00
friend class HasLocalDpIFManagerAttorney;
friend class HasLocalDpIFUserAttorney;
2020-10-01 12:05:24 +02:00
public:
virtual~ HasLocalDataPoolIF() {};
2020-12-03 13:00:04 +01:00
static constexpr uint32_t INVALID_LPID = localpool::INVALID_LPID;
2020-10-01 12:05:24 +02:00
2021-01-12 14:08:51 +01:00
virtual object_id_t getObjectId() const = 0;
2020-10-01 12:05:24 +02:00
/** 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(localpool::DataPool& localDataPoolMap,
2020-10-01 12:05:24 +02:00
LocalDataPoolManager& poolManager) = 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;
2020-12-03 13:00:04 +01:00
/**
* @brief This function will be called by the manager if an update
* notification is received.
2021-01-11 21:31:03 +01:00
* @details HasLocalDataPoolIF
2020-12-03 13:00:04 +01:00
* 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,
2021-01-12 14:08:51 +01:00
store_address_t storeId = storeId::INVALID_STORE_ADDRESS) {
2020-12-03 13:00:04 +01:00
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;
}
2021-01-11 21:31:03 +01:00
/**
* These function can be implemented by pool owner, if they are required
* and used by the housekeeping message interface.
* */
2020-10-01 12:05:24 +02:00
virtual ReturnValue_t addDataSet(sid_t sid) {
return HasReturnvaluesIF::RETURN_FAILED;
};
virtual ReturnValue_t removeDataSet(sid_t sid) {
return HasReturnvaluesIF::RETURN_FAILED;
};
2021-01-12 14:08:51 +01:00
virtual ReturnValue_t changeCollectionInterval(sid_t sid, float newIntervalSeconds) {
2020-10-01 12:05:24 +02:00
return HasReturnvaluesIF::RETURN_FAILED;
};
2021-01-11 20:20:39 +01:00
2021-01-11 21:31:03 +01:00
/**
2021-01-12 14:08:51 +01:00
* This function can be used by data pool consumers to retrieve a handle
2021-01-11 21:31:03 +01:00
* which allows subscriptions to dataset and variable updates.
* @return
*/
2021-01-11 22:25:39 +01:00
virtual ProvidesDataPoolSubscriptionIF* getSubscriptionInterface() = 0;
2021-01-12 00:13:49 +01:00
2021-01-11 20:20:39 +01:00
protected:
2021-01-12 14:08:51 +01:00
virtual AccessPoolManagerIF* getAccessorHandle() = 0;
2021-01-11 21:31:03 +01:00
/**
* This function is used by the pool manager to get a valid dataset
* from a SID. This function is protected to prevent users from
* using raw data set pointers which could not be thread-safe. Users
* should use the #ProvidesDataPoolSubscriptionIF.
* @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. This function is protected to prevent users from
* using raw pool variable pointers which could not be thread-safe.
* Users should use the #ProvidesDataPoolSubscriptionIF.
* @param localPoolId
* @return
*/
virtual LocalPoolObjectBase* getPoolObjectHandle(lp_id_t localPoolId) {
#if FSFW_CPP_OSTREAM_ENABLED == 1
sif::warning << "HasLocalDataPoolIF::getPoolObjectHandle: Not overriden"
<< ". Returning nullptr!" << std::endl;
#else
sif::printWarning("HasLocalDataPoolIF::getPoolObjectHandle: "
2021-01-11 21:31:03 +01:00
"Not overriden. Returning nullptr!\n");
#endif
return nullptr;
}
2020-10-01 12:05:24 +02:00
};
#endif /* FSFW_DATAPOOLLOCAL_HASLOCALDATAPOOLIF_H_ */