fsfw/src/fsfw/subsystem/SubsystemBase.h

#ifndef FSFW_SUBSYSTEM_SUBSYSTEMBASE_H_
#define FSFW_SUBSYSTEM_SUBSYSTEMBASE_H_

#include <map>

#include "fsfw/container/HybridIterator.h"
#include "fsfw/health/HasHealthIF.h"
#include "fsfw/health/HealthHelper.h"
#include "fsfw/ipc/MessageQueueIF.h"
#include "fsfw/modes/HasModesIF.h"
#include "fsfw/objectmanager/SystemObject.h"
#include "fsfw/returnvalues/returnvalue.h"
#include "fsfw/subsystem/HasModeTreeChildrenIF.h"
#include "fsfw/subsystem/ModeTreeConnectionIF.h"
#include "fsfw/tasks/ExecutableObjectIF.h"
#include "modes/HasModeSequenceIF.h"

/**
 * @defgroup subsystems Subsystem Objects
 * All Subsystem and Assemblies can derive from this class. It contains helper classes to
 * perform mode and health handling, which allows OBSW developers to build a mode tree for
 * the whole satellite.
 *
 * Aside from setting up a mode tree and being able to executing mode tables, this class does not
 * provide an implementation on what to do with the features. To build a mode tree, helper classes
 * like the #AssemblyBase or the #Subsystem class extend and use the functionality of the base
 * class.
 */
class SubsystemBase : public SystemObject,
                      public HasModesIF,
                      public HasHealthIF,
                      public HasModeTreeChildrenIF,
                      public ModeTreeConnectionIF,
                      public ModeTreeChildIF,
                      public ExecutableObjectIF {
 public:
  static const uint8_t INTERFACE_ID = CLASS_ID::SUBSYSTEM_BASE;
  static const ReturnValue_t CHILD_NOT_FOUND = MAKE_RETURN_CODE(0x01);
  static const ReturnValue_t CHILD_INFO_UPDATED = MAKE_RETURN_CODE(0x02);
  static const ReturnValue_t CHILD_DOESNT_HAVE_MODES = MAKE_RETURN_CODE(0x03);
  static const ReturnValue_t COULD_NOT_INSERT_CHILD = MAKE_RETURN_CODE(0x04);
  static const ReturnValue_t TABLE_CONTAINS_INVALID_OBJECT_ID = MAKE_RETURN_CODE(0x05);

  SubsystemBase(object_id_t setObjectId, Mode_t initialMode = 0, uint16_t commandQueueDepth = 8);
  virtual ~SubsystemBase();

  virtual MessageQueueId_t getCommandQueue() const override;

  ReturnValue_t connectModeTreeParent(HasModeTreeChildrenIF &parent) override;
  ModeTreeChildIF &getModeTreeChildIF() override;

  /**
   * Function to register the child objects.
   * Performs a checks if the child does implement HasHealthIF and/or HasModesIF
   *
   *    Also adds them to the internal childrenMap.
   *
   * @param objectId
   * @return returnvalue::OK if successful
   *           CHILD_DOESNT_HAVE_MODES if Child is no HasHealthIF and no HasModesIF
   *           COULD_NOT_INSERT_CHILD If the Child could not be added to the ChildrenMap
   */
  ReturnValue_t registerChild(const ModeTreeChildIF &child) override;

  ReturnValue_t initialize() override;

  ReturnValue_t performOperation(uint8_t opCode) override;

  ReturnValue_t setHealth(HealthState health) override;

  HasHealthIF::HealthState getHealth() override;

 protected:
  struct ChildInfo {
    MessageQueueId_t commandQueue;
    Mode_t mode;
    Submode_t submode;
    bool healthChanged;
  };

  Mode_t mode;

  Submode_t submode = SUBMODE_NONE;

  bool childrenChangedMode = false;

  /**
   * Always check this against <=0, so you are robust against too many replies
   */
  int32_t commandsOutstanding = 0;

  MessageQueueIF *commandQueue = nullptr;

  HealthHelper healthHelper;

  ModeHelper modeHelper;

  typedef std::map<object_id_t, ChildInfo> ChildrenMap;
  ChildrenMap childrenMap;

  void checkCommandQueue();

  /**
   * We need to know the target Submode, as children are able to inherit the submode
   */
  ReturnValue_t checkStateAgainstTable(HybridIterator<ModeListEntry> tableIter,
                                       Submode_t targetSubmode);

  /**
   * This function takes care of sending all according mode commands specified inside a mode table.
   * We need to know the target Submode, as children are able to inherit the submode
   * Still, we have a default for all child implementations which do not use submode inheritance
   */
  void executeTable(HybridIterator<ModeListEntry> tableIter,
                    Submode_t targetSubmode = SUBMODE_NONE);

  ReturnValue_t updateChildMode(MessageQueueId_t queue, Mode_t mode, Submode_t submode);

  ReturnValue_t updateChildChangedHealth(MessageQueueId_t queue, bool changedHealth = true);

  virtual ReturnValue_t handleModeReply(CommandMessage *message);

  void commandAllChildren(CommandMessage *message);

  ReturnValue_t checkTable(HybridIterator<ModeListEntry> tableIter);

  void replyToCommand(CommandMessage *message);

  void setMode(Mode_t newMode, Submode_t newSubmode);

  void setMode(Mode_t newMode);

  virtual ReturnValue_t handleCommandMessage(CommandMessage *message) = 0;

  virtual void performChildOperation() = 0;

  virtual ReturnValue_t checkModeCommand(Mode_t mode, Submode_t submode,
                                         uint32_t *msToReachTheMode) override = 0;

  virtual void startTransition(Mode_t mode, Submode_t submode) override = 0;

  virtual void getMode(Mode_t *mode, Submode_t *submode) override;

  object_id_t getObjectId() const override;
  const HasHealthIF *getOptHealthIF() const override;
  const HasModesIF &getModeIF() const override;

  virtual void setToExternalControl() override;

  virtual void announceMode(bool recursive) override;

  virtual void modeChanged();
};

#endif /* FSFW_SUBSYSTEM_SUBSYSTEMBASE_H_ */