//===-- rosa/agent/SystemState.hpp ------------------------------*- C++ -*-===//
//
//                                 The RoSA Framework
//
//===----------------------------------------------------------------------===//
///
/// \file rosa/agent/SystemState.hpp
///
/// \author Maximilian Götzinger (maximilian.goetzinger@tuwien.ac.at)
///
/// \date 2019
///
/// \brief Definition of *system state* *functionality*.
///
//===----------------------------------------------------------------------===//

#ifndef ROSA_AGENT_SYSTEMSTATE_HPP
#define ROSA_AGENT_SYSTEMSTATE_HPP

#include "rosa/agent/Functionality.h"
#include "rosa/agent/SignalState.hpp"

#include "rosa/support/debug.hpp"

#include <array>

namespace rosa {
namespace agent {

// System state conditions defining how the condition of a \c
/// rosa::agent::SystemState is saved in \c rosa::agent::SystemStateInformation.
enum class SystemStateCondition {
  STABLE,         ///< The system state is stable
  DRIFTING,       ///< The system state is drifting
  MALFUNCTIONING, ///< The system state is malfunctioning
  UNKNOWN         ///< The system state is unknown
};

/// TODO: write description
template <typename CONFDATATYPE> struct SystemStateInformation {
  // Make sure the actual type arguments are matching our expectations.
  STATIC_ASSERT((std::is_arithmetic<CONFDATATYPE>::value),
                "confidence type is not to arithmetic");

  /// The system state ID saved as an uint32_teger number
  uint32_t SystemStateID;
  /// The SystemStateConfidence shows the overall confidence value of the system
  /// state.
  CONFDATATYPE OverallDetectionConfidence;
  /// The SystemStateCondition shows the condition of a system state (stable,
  /// drifting, malfunctioning, or unknown)
  //@David: is it ok to name the variable exactly as the type is named?
  SystemStateCondition SystemStateCondition;
  /// The SystemStateIsValid saves the number of samples which have been
  /// inserted into the state after entering it.
  uint32_t NumberOfInsertedSamplesAfterEntrance;
  /// The SystemStateIsValid shows whether a state is valid or invalid.
  /// In this context, valid means that enough samples which are in close
  /// proximitry have been inserted into the state.
  bool SystemStateIsValid;
  /// The SystemStateJustGotValid shows whether a system state got valid
  /// (toggled from invalid to valid) during the current inserted sample.
  bool SystemStateJustGotValid;
  /// The SystemStateIsValidAfterReentrance shows whether a system state is
  /// valid after the variable changed back to it again.
  bool SystemStateIsValidAfterReentrance;
  /// The SystemIsStable shows whether a signa is stable and not
  /// drifting.
  bool SystemIsStable;
};

/// TODO TEXT
template <typename INDATATYPE, typename CONFDATATYPE, typename PROCDATATYPE,
          std::size_t NUMOFINPUTSIGNALS, std::size_t NUMOFOUTPUTSIGNALS>
class SystemState : public Functionality {

  // Make sure the actual type arguments are matching our expectations.
  STATIC_ASSERT(std::is_arithmetic<CONFDATATYPE>::value,
                "confidence abstraction type is not to arithmetic");

private:
  // TODO: vector
  std::array<SignalState<INDATATYPE, CONFDATATYPE, PROCDATATYPE>,
             NUMOFINPUTSIGNALS>
      InputSignalStates;
  std::array<SignalState<INDATATYPE, CONFDATATYPE, PROCDATATYPE>,
             NUMOFOUTPUTSIGNALS>
      OutputSignalStates;

public:
  //  SystemState(unsigned int NumberOfInputSignals) noexcept : {}
};

} // End namespace agent
} // End namespace rosa

#endif // ROSA_AGENT_SYSTEMSTATE_HPP