93 lines
3.1 KiB
C++
93 lines
3.1 KiB
C++
#ifndef FSFW_INTERNALERROR_INTERNALERRORREPORTER_H_
|
|
#define FSFW_INTERNALERROR_INTERNALERRORREPORTER_H_
|
|
|
|
#include "InternalErrorReporterIF.h"
|
|
#include "fsfw/datapoollocal/LocalDataPoolManager.h"
|
|
#include "fsfw/internalerror/InternalErrorDataset.h"
|
|
#include "fsfw/ipc/MutexIF.h"
|
|
#include "fsfw/objectmanager/SystemObject.h"
|
|
#include "fsfw/tasks/ExecutableObjectIF.h"
|
|
#include "fsfw/tasks/PeriodicTaskIF.h"
|
|
|
|
/**
|
|
* @brief This class is used to track internal errors like lost telemetry,
|
|
* failed message sending or a full store.
|
|
* @details
|
|
* All functions were kept virtual so this class can be extended easily
|
|
* to store custom internal errors (e.g. communication interface errors).
|
|
*/
|
|
class InternalErrorReporter : public SystemObject,
|
|
public ExecutableObjectIF,
|
|
public InternalErrorReporterIF,
|
|
public HasLocalDataPoolIF {
|
|
public:
|
|
InternalErrorReporter(object_id_t setObjectId, uint32_t messageQueueDepth,
|
|
bool enableSetByDefault, float generationFrequency);
|
|
|
|
/**
|
|
* Enable diagnostic printout. Please note that this feature will
|
|
* only work if DEBUG has been supplied to the build defines.
|
|
* @param enable
|
|
*/
|
|
void setDiagnosticPrintout(bool enable);
|
|
|
|
void setMutexTimeout(MutexIF::TimeoutType timeoutType, uint32_t timeoutMs);
|
|
|
|
virtual ~InternalErrorReporter();
|
|
|
|
virtual object_id_t getObjectId() const override;
|
|
virtual MessageQueueId_t getCommandQueue() const override;
|
|
virtual ReturnValue_t initializeLocalDataPool(localpool::DataPool& localDataPoolMap,
|
|
LocalDataPoolManager& poolManager) override;
|
|
virtual dur_millis_t getPeriodicOperationFrequency() const override;
|
|
virtual LocalPoolDataSetBase* getDataSetHandle(sid_t sid) override;
|
|
LocalDataPoolManager* getHkManagerHandle() override;
|
|
|
|
virtual ReturnValue_t initialize() override;
|
|
virtual ReturnValue_t initializeAfterTaskCreation() override;
|
|
virtual ReturnValue_t performOperation(uint8_t opCode) override;
|
|
|
|
virtual void queueMessageNotSent() override;
|
|
|
|
virtual void lostTm() override;
|
|
|
|
virtual void storeFull() override;
|
|
|
|
virtual void setTaskIF(PeriodicTaskIF* task) override;
|
|
|
|
protected:
|
|
MessageQueueIF* commandQueue;
|
|
LocalDataPoolManager poolManager;
|
|
|
|
PeriodicTaskIF* executingTask = nullptr;
|
|
|
|
MutexIF* mutex = nullptr;
|
|
MutexIF::TimeoutType timeoutType = MutexIF::TimeoutType::WAITING;
|
|
uint32_t timeoutMs = 20;
|
|
bool enableSetByDefault;
|
|
float generationFrequency;
|
|
|
|
sid_t internalErrorSid;
|
|
InternalErrorDataset internalErrorDataset;
|
|
|
|
bool diagnosticPrintout = true;
|
|
|
|
uint32_t queueHits = 0;
|
|
uint32_t tmHits = 0;
|
|
uint32_t storeHits = 0;
|
|
PoolEntry<uint32_t> tmHitsEntry = PoolEntry<uint32_t>();
|
|
PoolEntry<uint32_t> storeHitsEntry = PoolEntry<uint32_t>();
|
|
PoolEntry<uint32_t> queueHitsEntry = PoolEntry<uint32_t>();
|
|
|
|
uint32_t getAndResetQueueHits();
|
|
void incrementQueueHits();
|
|
|
|
uint32_t getAndResetTmHits();
|
|
void incrementTmHits();
|
|
|
|
uint32_t getAndResetStoreHits();
|
|
void incrementStoreHits();
|
|
};
|
|
|
|
#endif /* FSFW_INTERNALERROR_INTERNALERRORREPORTER_H_ */
|