fsfw/src/fsfw/controller/ControllerBase.cpp

127 lines
3.7 KiB
C++
Raw Normal View History

2021-07-13 20:22:54 +02:00
#include "fsfw/controller/ControllerBase.h"
2020-12-03 13:14:30 +01:00
2021-07-13 20:22:54 +02:00
#include "fsfw/action/HasActionsIF.h"
2022-02-02 10:29:30 +01:00
#include "fsfw/ipc/QueueFactory.h"
2021-07-13 20:22:54 +02:00
#include "fsfw/objectmanager/ObjectManager.h"
2022-02-02 10:29:30 +01:00
#include "fsfw/subsystem/SubsystemBase.h"
2020-12-03 13:14:30 +01:00
ControllerBase::ControllerBase(object_id_t setObjectId, object_id_t parentId,
2022-02-02 10:29:30 +01:00
size_t commandQueueDepth)
: SystemObject(setObjectId),
parentId(parentId),
mode(MODE_OFF),
submode(SUBMODE_NONE),
modeHelper(this),
healthHelper(this, setObjectId) {
2022-02-19 16:14:02 +01:00
auto mqArgs = MqArgs(setObjectId, static_cast<void*>(this));
2022-02-22 10:17:56 +01:00
commandQueue = QueueFactory::instance()->createMessageQueue(
commandQueueDepth, MessageQueueMessage::MAX_MESSAGE_SIZE, &mqArgs);
}
2022-02-02 10:29:30 +01:00
ControllerBase::~ControllerBase() { QueueFactory::instance()->deleteMessageQueue(commandQueue); }
ReturnValue_t ControllerBase::initialize() {
2022-02-02 10:29:30 +01:00
ReturnValue_t result = SystemObject::initialize();
2022-08-16 01:08:26 +02:00
if (result != returnvalue::OK) {
2022-02-02 10:29:30 +01:00
return result;
}
MessageQueueId_t parentQueue = 0;
if (parentId != objects::NO_OBJECT) {
auto* parent = ObjectManager::instance()->get<SubsystemBase>(parentId);
2022-02-02 10:29:30 +01:00
if (parent == nullptr) {
2022-08-16 01:08:26 +02:00
return returnvalue::FAILED;
}
2022-02-02 10:29:30 +01:00
parentQueue = parent->getCommandQueue();
2022-02-02 10:29:30 +01:00
parent->registerChild(getObjectId());
}
2022-02-02 10:29:30 +01:00
result = healthHelper.initialize(parentQueue);
2022-08-16 01:08:26 +02:00
if (result != returnvalue::OK) {
2022-02-02 10:29:30 +01:00
return result;
}
2022-02-02 10:29:30 +01:00
result = modeHelper.initialize(parentQueue);
2022-08-16 01:08:26 +02:00
if (result != returnvalue::OK) {
2022-02-02 10:29:30 +01:00
return result;
}
2022-08-16 01:08:26 +02:00
return returnvalue::OK;
}
2022-02-02 10:29:30 +01:00
MessageQueueId_t ControllerBase::getCommandQueue() const { return commandQueue->getId(); }
void ControllerBase::handleQueue() {
2022-02-02 10:29:30 +01:00
CommandMessage command;
ReturnValue_t result;
2022-08-16 01:08:26 +02:00
for (result = commandQueue->receiveMessage(&command); result == returnvalue::OK;
2022-02-02 10:29:30 +01:00
result = commandQueue->receiveMessage(&command)) {
result = modeHelper.handleModeCommand(&command);
2022-08-16 01:08:26 +02:00
if (result == returnvalue::OK) {
2022-02-02 10:29:30 +01:00
continue;
}
2022-02-02 10:29:30 +01:00
result = healthHelper.handleHealthCommand(&command);
2022-08-16 01:08:26 +02:00
if (result == returnvalue::OK) {
2022-02-02 10:29:30 +01:00
continue;
}
result = handleCommandMessage(&command);
2022-08-16 01:08:26 +02:00
if (result == returnvalue::OK) {
2022-02-02 10:29:30 +01:00
continue;
}
command.setToUnknownCommand();
commandQueue->reply(&command);
}
}
void ControllerBase::startTransition(Mode_t mode_, Submode_t submode_) {
2022-02-02 10:29:30 +01:00
changeHK(this->mode, this->submode, false);
triggerEvent(CHANGING_MODE, mode, submode);
mode = mode_;
submode = submode_;
2022-02-02 10:29:30 +01:00
modeHelper.modeChanged(mode, submode);
modeChanged(mode, submode);
announceMode(false);
changeHK(this->mode, this->submode, true);
}
void ControllerBase::getMode(Mode_t* mode_, Submode_t* submode_) {
*mode_ = this->mode;
*submode_ = this->submode;
}
2022-02-02 10:29:30 +01:00
void ControllerBase::setToExternalControl() { healthHelper.setHealth(EXTERNAL_CONTROL); }
2022-02-02 10:29:30 +01:00
void ControllerBase::announceMode(bool recursive) { triggerEvent(MODE_INFO, mode, submode); }
ReturnValue_t ControllerBase::performOperation(uint8_t opCode) {
2022-02-02 10:29:30 +01:00
handleQueue();
performControlOperation();
2022-08-16 01:08:26 +02:00
return returnvalue::OK;
}
void ControllerBase::modeChanged(Mode_t mode_, Submode_t submode_) {}
const ModeHelper * ControllerBase::getModeHelper() const {
return &modeHelper;
}
ReturnValue_t ControllerBase::setHealth(HealthState health) {
2022-02-02 10:29:30 +01:00
switch (health) {
case HEALTHY:
case EXTERNAL_CONTROL:
2022-02-02 10:29:30 +01:00
healthHelper.setHealth(health);
2022-08-16 01:08:26 +02:00
return returnvalue::OK;
default:
2022-02-02 10:29:30 +01:00
return INVALID_HEALTH_STATE;
}
}
2022-02-02 10:29:30 +01:00
HasHealthIF::HealthState ControllerBase::getHealth() { return healthHelper.getHealth(); }
void ControllerBase::setTaskIF(PeriodicTaskIF* task_) { executingTask = task_; }
void ControllerBase::changeHK(Mode_t mode_, Submode_t submode_, bool enable) {}
2020-12-03 13:14:30 +01:00
2022-08-16 01:08:26 +02:00
ReturnValue_t ControllerBase::initializeAfterTaskCreation() { return returnvalue::OK; }