/**
 * \file core/spoms/locationbackup.h
 * \date 16/02/2026
 * \author Aurélien Berthier, BENOIST Emile, TESSIER Dominique
 * \brief store alignment interpretations
 */


/*
 * PeptidOMS, Spectra to protein alignment tool
 * Copyright (C) 2026  Olivier Langella
 * <olivier.langella@cnrs.fr>
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 */

#pragma once
#include <pappsomspp/core/massspectrum/qualifiedmassspectrum.h>

namespace pappso
{
namespace spoms
{
class Protein;
/*
 * Cette objet contient une liste de scenario, formant ainsi, une interpretation
 * complete du spectre. Lorsque un alignement entre une proteine est un spectre
 * est effectue, une matrice de scenario est mise a jour. En passant a la
 * proteine suivante (ou au spectre suivant), il est necessaire d'effectuer une
 * sauvegarde des bonnes interpretations (liste de scenarios consecutif) de la
 * matrice pour que ceux la ne soit pas ecrase par l'alignement suivant. L'objet
 * "ScenarioBackup" correspond a la sauvegarde de l'une de ces interpretation.
 * Lorsque qu'une interpretation interessante est trouvee, l'une des methodes
 * "update" est appelee pour mettre a jour un "pointeur" vers le scenario de la
 * matrice qui termine dans l'interpretation. Lorsque que l'alignement est
 * termine, une copie de l'interpretation pointee est effectuee ici pour la
 * sauvegarder.
 */
class LocationBackup
{


  /*
   * Un "ScenarioBackup" est initialise avec une liste de scenarios vides. Le
   * nombre de ces scenarios est fixe au nombre de colonne que contient la
   * matrice de score car une interpretation ne peut pas contenir plus de
   * scenarios qu'il n'y a de colonne (les cas 'not found' ne sont pas compte
   * comme des scenarios).
   */
  public:
  LocationBackup();
  LocationBackup(const pappso::spoms::Protein *protein_p,
                 int start_line,
                 int end_line,
                 int score,
                 int tree_id);
  LocationBackup(const LocationBackup &other);
  virtual ~LocationBackup();


  void update(int start_line, int end_line, int score, int tree_id);


  QString toString() const;

  QString getSubSequence() const;

  public:
  const pappso::spoms::Protein *mp_protein = nullptr;
  int start_line                           = 0;
  int end_line                             = 0;
  int score                                = 0;
  int tree_id                              = 0;
};
} // namespace spoms
} // namespace pappso
