//
// ********************************************************************
// * License and Disclaimer                                           *
// *                                                                  *
// * The  Geant4 software  is  copyright of the Copyright Holders  of *
// * the Geant4 Collaboration.  It is provided  under  the terms  and *
// * conditions of the Geant4 Software License,  included in the file *
// * LICENSE and available at  http://cern.ch/geant4/license .  These *
// * include a list of copyright holders.                             *
// *                                                                  *
// * Neither the authors of this software system, nor their employing *
// * institutes,nor the agencies providing financial support for this *
// * work  make  any representation or  warranty, express or implied, *
// * regarding  this  software system or assume any liability for its *
// * use.  Please see the license in the file  LICENSE  and URL above *
// * for the full disclaimer and the limitation of liability.         *
// *                                                                  *
// * This  code  implementation is the result of  the  scientific and *
// * technical work of the GEANT4 collaboration.                      *
// * By using,  copying,  modifying or  distributing the software (or *
// * any work based  on the software)  you  agree  to acknowledge its *
// * use  in  resulting  scientific  publications,  and indicate your *
// * acceptance of all terms of the Geant4 Software license.          *
// ********************************************************************
//
//
// 080721 Create adjust_final_state method by T. Koi
// 080801 Introduce theNDLDataA,Z which has A and Z of NDL data by T. Koi
//
// P. Arce, June-2014 Conversion neutron_hp to particle_hp
// V. Ivanchenko, July-2023 Basic revision of particle HP classes
//

#ifndef G4ParticleHPFinalState_h
#define G4ParticleHPFinalState_h

#include "G4Cache.hh"
#include "G4HadFinalState.hh"
#include "G4HadProjectile.hh"
#include "G4Material.hh"
#include "G4Neutron.hh"
#include "G4IonTable.hh"
#include "G4ParticleHPManager.hh"
#include "G4ParticleHPNames.hh"
#include "G4ParticleHPVector.hh"

class G4ParticleDefinition;

class G4ParticleHPFinalState
{
  public:

    G4ParticleHPFinalState();
    virtual ~G4ParticleHPFinalState();

    inline void Init(G4double A, G4double Z, const G4String& dirName,
                     const G4String& aFSType, G4ParticleDefinition* p)
    {
      theProjectile = p;
      Init(A, Z, 0, dirName, aFSType, p);
    }
    virtual void Init(G4double A, G4double Z, G4int M, const G4String& dirName,
                      const G4String& aFSType, G4ParticleDefinition*) = 0;

    virtual G4HadFinalState* ApplyYourself(const G4HadProjectile&)
    {
      throw G4HadronicException(
        __FILE__, __LINE__,
        "G4ParticleHPFinalState::ApplyYourself(..) needs implementation");
      return nullptr;
    }

    // this would better be done templating G4ParticleHPChannel...,
    //
    virtual G4ParticleHPFinalState* New() = 0;

    inline G4bool HasXsec() const { return hasXsec; }
    inline G4bool HasFSData() const { return hasFSData; }
    inline G4bool HasAnyData() const { return hasAnyData; }

    virtual G4double GetXsec(G4double) const { return 0.; }
    virtual G4ParticleHPVector* GetXsec() const { return nullptr; }

    void SetA_Z(G4double anA, G4double aZ, G4int aM = 0)
    {
      theBaseA = G4lrint(anA);
      theBaseZ = G4lrint(aZ);
      theBaseM = aM;
    }
    G4double GetZ() const { return theBaseZ; }
    G4double GetN() const { return theBaseA; }
    G4double GetA() const { return theBaseA; }
    G4int GetM() const { return theBaseM; }

    inline void SetAZMs(const G4ParticleHPDataUsed& used)
    {
      theNDLDataA = G4lrint(used.GetA());
      theNDLDataZ = G4lrint(used.GetZ());
      theNDLDataM = used.GetM();
    }

    inline void SetAZMs(G4double anA, G4double aZ, G4int aM, const G4ParticleHPDataUsed& used)
    {
      theBaseA = G4lrint(anA);
      theBaseZ = G4lrint(aZ);
      theBaseM = aM;
      theNDLDataA = G4lrint(used.GetA());
      theNDLDataZ = G4lrint(used.GetZ());
      theNDLDataM = used.GetM();
    }

    inline void SetProjectile(G4ParticleDefinition* projectile)
    {
      theProjectile = projectile;
    }

    G4ParticleHPFinalState& operator=(const G4ParticleHPFinalState& right) = delete;
    G4ParticleHPFinalState(const G4ParticleHPFinalState&) = delete;

  protected:

    void adjust_final_state(G4LorentzVector);

    G4ParticleDefinition* theProjectile{nullptr};
    G4ParticleHPManager* fManager;
    G4IonTable* ionTable;

    G4int theBaseA{0};
    G4int theBaseZ{0};
    G4int theBaseM{0};
    G4int theNDLDataZ{0};
    G4int theNDLDataA{0};
    G4int theNDLDataM{0};

    G4int secID{-1};
    // Creator model ID for the secondaries created by this class or derived ones

    G4bool hasXsec{true};
    G4bool hasFSData{true};
    G4bool hasAnyData{true};
    G4ParticleHPNames theNames;

    G4Cache<G4HadFinalState*> theResult;

};

#endif