action
container
contrib
controller
coordinates
datalinklayer
datapool
CMakeLists.txt
DataSetIF.h
HkSwitchHelper.cpp
HkSwitchHelper.h
PoolDataSetBase.cpp
PoolDataSetBase.h
PoolDataSetIF.h
PoolEntry.cpp
PoolEntry.h
PoolEntryIF.h
PoolReadHelper.h
PoolVarList.h
PoolVariableIF.h
ReadCommitIF.h
SharedDataSetIF.h
datapoollocal
defaultcfg
devicehandlers
doc
events
fdir
globalfunctions
health
housekeeping
internalError
ipc
logo
memory
modes
monitoring
objectmanager
osal
parameters
power
pus
returnvalues
rmap
serialize
serviceinterface
storagemanager
subsystem
tasks
tcdistribution
thermal
timemanager
tmstorage
tmtcpacket
tmtcservices
unittest
.gitignore
.gitmodules
CHANGELOG
CMakeLists.txt
FSFWVersion.h
LICENSE
NOTICE
README.md
fsfw.mk
52 lines
1.5 KiB
C++
52 lines
1.5 KiB
C++
#ifndef FSFW_DATAPOOL_POOLREADHELPER_H_
|
|
#define FSFW_DATAPOOL_POOLREADHELPER_H_
|
|
|
|
#include "ReadCommitIF.h"
|
|
#include "../serviceinterface/ServiceInterface.h"
|
|
#include <FSFWConfig.h>
|
|
|
|
/**
|
|
* @brief Helper class to read data sets or pool variables
|
|
*/
|
|
class PoolReadHelper {
|
|
public:
|
|
PoolReadHelper(ReadCommitIF* readObject,
|
|
MutexIF::TimeoutType timeoutType = MutexIF::TimeoutType::WAITING,
|
|
uint32_t mutexTimeout = 20):
|
|
readObject(readObject), mutexTimeout(mutexTimeout) {
|
|
if(readObject != nullptr) {
|
|
readResult = readObject->read(timeoutType, mutexTimeout);
|
|
if(readResult != HasReturnvaluesIF::RETURN_OK) {
|
|
#if FSFW_VERBOSE_LEVEL == 1
|
|
#if FSFW_CPP_OSTREAM_ENABLED == 1
|
|
sif::error << "PoolReadHelper: Read failed!" << std::endl;
|
|
#else
|
|
sif::printError("PoolReadHelper: Read failed!\n");
|
|
#endif /* FSFW_PRINT_VERBOSITY_LEVEL == 1 */
|
|
#endif /* FSFW_CPP_OSTREAM_ENABLED == 1 */
|
|
}
|
|
}
|
|
}
|
|
|
|
ReturnValue_t getReadResult() const {
|
|
return readResult;
|
|
}
|
|
|
|
~PoolReadHelper() {
|
|
if(readObject != nullptr) {
|
|
readObject->commit(timeoutType, mutexTimeout);
|
|
}
|
|
|
|
}
|
|
|
|
private:
|
|
ReadCommitIF* readObject = nullptr;
|
|
ReturnValue_t readResult = HasReturnvaluesIF::RETURN_OK;
|
|
MutexIF::TimeoutType timeoutType = MutexIF::TimeoutType::WAITING;
|
|
uint32_t mutexTimeout = 20;
|
|
};
|
|
|
|
|
|
|
|
#endif /* FSFW_DATAPOOL_POOLREADHELPER_H_ */
|