CaDataManager.h

/* Copyright (C) 2022 GSI Helmholtzzentrum fuer Schwerionenforschung, Darmstadt
   SPDX-License-Identifier: GPL-3.0-only
   Authors: Sergey Gorbunov, Sergei Zharko [committer] */

/// \file L1IODataManager.h
/// \brief Input-output data manager for L1 tracking algorithm
/// \since 05.08.2022
/// \author S.Zharko <s.zharko@gsi.de>

#ifndef L1IODataManager_h
#define L1IODataManager_h 1

#include "CaConstants.h"
#include "CaInputData.h"

using namespace cbm::algo::ca;  //TODO: remove

class L1Algo;
//class L1OutputData;

/// Class L1IODataManager defines the interface for input and output data flow in the L1 tracking algorithm
///
class alignas(constants::misc::Alignment) L1IODataManager {
public:
  // ***************************
  // ** Member functions list **
  // ***************************

  // ** Constructors and destructor **

  /// Default constructor
  L1IODataManager() = default;

  /// Destructor
  ~L1IODataManager() = default;

  /// Copy constructor
  L1IODataManager(const L1IODataManager& other) = delete;

  /// Move constructor
  L1IODataManager(L1IODataManager&& other) = delete;

  /// Copy assignment operator
  L1IODataManager& operator=(const L1IODataManager& other) = delete;

  /// Move assignment operator
  L1IODataManager& operator=(L1IODataManager&& other) = delete;

  /// @brief Gets number of hits stored
  /// @return  Number of hits
  int GetNofHits() { return fInputData.fHits.size(); }

  /// Reads input data object from boost-serialized binary file
  /// \param  fileName  Name of input file
  void ReadInputData(const std::string& fileName);

  /// Reserve number of hits
  /// \param  nHits  Number of hits to be stored
  /// \note   If one does not call this method, the underlying vector of hits will be filled with the time penalty
  void ReserveNhits(ca::HitIndex_t nHits) { fInputData.fHits.reserve(nHits); }

  /// @brief  Resets the input data block
  /// @param  nHits  Number of hits to reserve
  void ResetInputData(ca::HitIndex_t nHits = 0) noexcept;

  /// Pushes back a hit
  /// \param  hit  An ca::Hit object
  void PushBackHit(const ca::Hit& hit, int64_t streamId)
  {
    if (fInputData.fStreamStartIndices.size() == 0 || fLastStreamId != streamId) {  // new data stream
      fLastStreamId = streamId;
      fInputData.fStreamStartIndices.push_back(fInputData.fHits.size());
      // for a case.. it is fixed later in InitData()
      fInputData.fStreamStopIndices.push_back(fInputData.fHits.size());
    }
    fInputData.fHits.push_back(hit);
  }

  /// Sets the number of hit keys
  /// \param  nKeys  Number of hit keys
  void SetNhitKeys(int nKeys) { fInputData.fNhitKeys = nKeys; }

  /// @brief Sets number of active stations
  /// @param nStations  Number of stations
  void SetNofActiveStations(int nStations) { fNofActiveStations = nStations; }

  /// Sends (moves) input data to the destination reference
  /// \param  pAlgo  Pointer to the L1 tracking algorithm main class
  /// \return Success flag
  bool SendInputData(L1Algo* pAlgo);

  /// @brief Sends (moves) input data to an object (alternative method of data sending)
  /// @param destination  Destination object of input data
  bool SendInputData(L1InputData& destination);

  /// \brief Takes (moves) the instance of the input data object
  L1InputData&& TakeInputData();

  /// Writes input data object to boost-serialized binary file
  /// \param  fileName  Name of input file
  void WriteInputData(const std::string& fileName) const;


private:
  /// @brief Initializes data object
  ///
  /// Sorts hits by stations (complexity O(n)) and defines bordering hit index for station
  void InitData();

  /// Provides quick QA for input data
  /// \tparam  Level  The level of the checks. The values of the parameter:
  ///                 - 0: no checks will be done
  ///                 - 1: only number of hits and strips as well as validity of hits first and last indexes will be checked
  ///                 - 2: hits sorting is checked
  ///                 - 3: every hit is checked for consistency
  /// \note    The larger Level corresponds to more precise checks, but is followed by larger time penalty
  template<int Level>
  bool CheckInputData() const;


  // ***************************
  // ** Member variables list **
  // ***************************

  L1InputData fInputData {};  ///< Object of input data

  int64_t fLastStreamId {-1};   ///< data stream Id of the last hit added
  int fNofActiveStations = -1;  ///< Number of active stations
};


// *************************************
// ** Inline functions implementation **
// *************************************

// ---------------------------------------------------------------------------------------------------------------------
//

// TODO: Complete this function
template<int Level>
inline bool L1IODataManager::CheckInputData() const
{
  if constexpr (Level == 0) { return true; }  // Level = 0 -> do nothing
  else if constexpr (Level > 0) {             // Level = 1 and higher
    // ----- Check if the hits container is not empty ------------------------------------------------------------------
    if (fInputData.fHits.size() == 0) {
      LOG(warn) << "L1IODataManager [check input]: Sample contains empty hits, tracking will not be executed";
      return false;
    }

    // ----- Checks if the number of hit keys is valid -----------------------------------------------------------------
    if (fInputData.fNhitKeys < 1) {
      LOG(error) << "L1IODataManager [check input]: Incorrect number of keys passed (" << fInputData.fNhitKeys
                 << "), tracking will not be executed";
      return false;
    }

    // ----- Checks the indexes of first and last hits in stations
    // TODO: Add one of the two following checks for fvStartHitIn

    if constexpr (Level > 1) {  // Level = 2 and higher
      // ----- Checks for hits sorting ---------------------------------------------------------------------------------
      // TODO...
      if constexpr (Level > 2) {  // Level = 3 and higher
        // ----- Checks for consistency of the particular hit ----------------------------------------------------------
        // TODO...
      }
    }
    return true;
  }
  return true;
}


#endif  // L1IODataManager_h