geant4/source/processes/electromagnetic/dna/management/include/G4TrackingInformation.hh

//
// ********************************************************************
// * 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.          *
// ********************************************************************
//
//
// Author: Mathieu Karamitros

// The code is developed in the framework of the ESA AO7146
//
// We would be very happy hearing from you, send us your feedback! :)
//
// In order for Geant4-DNA to be maintained and still open-source,
// article citations are crucial. 
// If you use Geant4-DNA chemistry and you publish papers about your software, 
// in addition to the general paper on Geant4-DNA:
//
// Int. J. Model. Simul. Sci. Comput. 1 (2010) 157–178
//
// we would be very happy if you could please also cite the following
// reference papers on chemistry:
//
// J. Comput. Phys. 274 (2014) 841-882
// Prog. Nucl. Sci. Tec. 2 (2011) 503-508 

#ifndef G4TRACKINGINFORMATION_HH
#define G4TRACKINGINFORMATION_HH

#include "globals.hh"
#include <vector>
#include <map>
#include "G4StepStatus.hh"
#include "G4ThreeVector.hh"
#include "G4TouchableHandle.hh"
#include "G4TrackState.hh"
#include "G4memory.hh"
#include "G4ITStepProcessorState_Lock.hh"

class G4ITStepProcessor;

using  G4SelectedAtRestDoItVector = std::vector<G4int>;
using  G4SelectedAlongStepDoItVector = std::vector<G4int>;
using  G4SelectedPostStepDoItVector = std::vector<G4int>;
using  G4SelectedPostStepAtTimeDoItVector = std::vector<G4int>;

class G4Trajectory_Lock;
class G4Track;
struct G4ProcessState_Lock;
class G4TrackingInformation;
class G4SaveNavigatorState_Lock;
struct G4ITNavigatorState_Lock;

/** The class G4TrackingInformation (hold by G4IT)
 *  emcompasses processes informations computed
 *  at the PS/AS/AtRest/InteractionLength stage,
 *  and also, the selection of processes for the
 *  given step.
 */
class G4TrackingInformation
{
public:
  G4TrackingInformation();
  ~G4TrackingInformation();

  //________________________________________________
  /** If the track is the one having the minimum step time,
   *  then it "leads" the step. It will interact will all the
   *  other tracks will be transported.
   */
  inline bool IsLeadingStep()
  {
    return fStepLeader;
  }
  inline void SetLeadingStep(bool value)
  {
    fStepLeader = value;
  }

  //________________________________________________
  /** Every process should store the information
   * computed at the InteractionLegth stage in the track.
   */

  G4shared_ptr<G4ProcessState_Lock> GetProcessState(size_t index);

  inline void RecordProcessState(G4shared_ptr<G4ProcessState_Lock>,
                                 size_t index);

  //___________________________________________________

  void SetStepProcessorState(G4ITStepProcessorState_Lock*);
  G4ITStepProcessorState_Lock* GetStepProcessorState();

  /*
   std::map<int,G4VTrackStateHandle> fTrackStates;
   std::map<void*,G4VTrackStateHandle> fMultipleTrackStates;

   void SetTrackState(void* adress, G4VTrackStateHandle state)
   {
   fMultipleTrackStates[adress] = state;
   }
   G4VTrackStateHandle GetTrackState(void* adress)
   {
   return fMultipleTrackStates[adress];
   }

   void SetTrackState(G4VTrackStateHandle state)
   {
   fTrackStates[state->GetID()] = state;
   }
   template<typename T> G4VTrackStateHandle GetTrackState()
   {
   return fTrackStates[G4TrackStateID<T>::GetID()] ;
   }
   */

  G4TrackStateManager& GetTrackStateManager()
  {
    return fTrackStateManager;
  }
  /*
   G4TrackStateManager& GetTrackStateManager() const
   {
   return fTrackStateManager;
   }
   */
  inline G4Trajectory_Lock* GetTrajectory_Lock()
  {
    return fpTrajectory_Lock;
  }

  inline void SetTrajectory_Lock(G4Trajectory_Lock* trajLock)
  {
    fpTrajectory_Lock = trajLock;
  }

  void RecordCurrentPositionNTime(G4Track*);
  inline const G4ThreeVector& GetPreStepPosition() const;
  inline G4double GetPreStepLocalTime() const;
  inline G4double GetPreStepGlobalTime() const;

  inline void SetNavigatorState(G4ITNavigatorState_Lock *);
  inline G4ITNavigatorState_Lock* GetNavigatorState() const;

  //-------------
protected:
  //-------------
  friend class G4ITStepProcessor;
  //_______________________________________________________
  G4bool fStepLeader{false};
  //_______________________________________________________
  G4Trajectory_Lock* fpTrajectory_Lock;

  G4TrackStateManager fTrackStateManager;

  //_______________________________________________________
  G4ThreeVector fRecordedTrackPosition;
  G4double fRecordedTrackLocalTime;
  G4double fRecordedTrackGlobalTime;

  //_______________________________________________________
  G4ITNavigatorState_Lock* fNavigatorState;
//    G4SaveNavigatorState_Lock* fNavigatorState;

//_______________________________________________________
  /** Holds the information related to processes
   *  Indexed on GetPhysIntVector
   * (cf. G4ITStepProcessor header)
   */
//    std::vector<G4ProcessState_Lock*> fProcessState;
  std::vector<G4shared_ptr<G4ProcessState_Lock> > fProcessState;

  //_______________________________________________________
  G4ITStepProcessorState_Lock* fpStepProcessorState{nullptr};

  //_______________________________________________________
  /** Copy constructor
   *  \param other Object to copy from
   */
  G4TrackingInformation(const G4TrackingInformation& other);

  /** Assignment operator
   *  \param other Object to assign from
   *  \return A reference to this
   */
  G4TrackingInformation& operator=(const G4TrackingInformation& other);
};

inline
void G4TrackingInformation::SetStepProcessorState(G4ITStepProcessorState_Lock* state)
{
  fpStepProcessorState = state;
}

inline G4ITStepProcessorState_Lock* G4TrackingInformation::GetStepProcessorState()
{
  return fpStepProcessorState;
}
/*
 inline void G4TrackingInformation::RecordProcessState(G4ProcessState_Lock* state,
 size_t index)
 {
 // G4cout << "G4TrackingInformation::RecordProcessState" << G4endl;
 fProcessState[index] = state;
 }*/

inline
void G4TrackingInformation::RecordProcessState(G4shared_ptr<G4ProcessState_Lock> state,
                                               size_t index)
{
  fProcessState[index] = std::move(state);
}

inline G4double G4TrackingInformation::GetPreStepGlobalTime() const
{
  return fRecordedTrackGlobalTime;
}

inline G4double G4TrackingInformation::GetPreStepLocalTime() const
{
  return fRecordedTrackLocalTime;
}

inline const G4ThreeVector& G4TrackingInformation::GetPreStepPosition() const
{
  return fRecordedTrackPosition;
}

inline void G4TrackingInformation::SetNavigatorState(G4ITNavigatorState_Lock* state)
{
  // G4cout << "Set Navigator state : " << state << G4endl;
  fNavigatorState = state;
}

inline G4ITNavigatorState_Lock* G4TrackingInformation::GetNavigatorState() const
{
  return fNavigatorState;
}

#endif // G4TRACKINGINFORMATION_HH