fsfw/src/fsfw/health/HasHealthIF.h

#ifndef FSFW_HEALTH_HASHEALTHIF_H_
#define FSFW_HEALTH_HASHEALTHIF_H_

#include "../events/Event.h"
#include "../ipc/MessageQueueSenderIF.h"
#include "../returnvalues/returnvalue.h"

class HasHealthIF {
 public:
  enum HealthState : uint8_t {
    HEALTHY = 1,
    FAULTY = 0,
    EXTERNAL_CONTROL = 2,
    NEEDS_RECOVERY = 3,
    PERMANENT_FAULTY = 4
  };

  static const uint8_t INTERFACE_ID = CLASS_ID::HAS_HEALTH_IF;
  static constexpr ReturnValue_t OBJECT_NOT_HEALTHY = returnvalue::makeCode(INTERFACE_ID, 1);
  static constexpr ReturnValue_t INVALID_HEALTH_STATE = returnvalue::makeCode(INTERFACE_ID, 2);
  static constexpr ReturnValue_t IS_EXTERNALLY_CONTROLLED = returnvalue::makeCode(INTERFACE_ID, 3);

  static const uint8_t SUBSYSTEM_ID = SUBSYSTEM_ID::SYSTEM_MANAGER_1;
  //! P1: New Health, P2: Old Health
  static const Event HEALTH_INFO = MAKE_EVENT(6, severity::INFO);
  static const Event CHILD_CHANGED_HEALTH = MAKE_EVENT(7, severity::INFO);
  static const Event CHILD_PROBLEMS = MAKE_EVENT(8, severity::LOW);
  //! Assembly overwrites health information of children to keep satellite alive.
  static const Event OVERWRITING_HEALTH = MAKE_EVENT(9, severity::LOW);
  //! Someone starts a recovery of a component (typically power-cycle). No parameters.
  static const Event TRYING_RECOVERY = MAKE_EVENT(10, severity::MEDIUM);
  //! Recovery is ongoing. Comes twice during recovery.
  //! P1: 0 for the first, 1 for the second event. P2: 0
  static const Event RECOVERY_STEP = MAKE_EVENT(11, severity::MEDIUM);
  //! Recovery was completed. Not necessarily successful. No parameters.
  static const Event RECOVERY_DONE = MAKE_EVENT(12, severity::MEDIUM);
  virtual ~HasHealthIF() {}

  virtual MessageQueueId_t getCommandQueue() const = 0;

  /**
   * @brief   Set the Health State
   * The parent will be informed, if the Health changes
   * @param health
   */
  virtual ReturnValue_t setHealth(HealthState health) = 0;

  /**
   * @brief   Get Health State
   * @return  Health State of the object
   */
  virtual HasHealthIF::HealthState getHealth() = 0;
};

#endif /* FSFW_HEALTH_HASHEALTHIF_H_ */