Geant4Primary.h

Go to the documentation of this file.

// $Id: $
//==========================================================================
//  AIDA Detector description implementation for LCD
//--------------------------------------------------------------------------
// Copyright (C) Organisation europeenne pour la Recherche nucleaire (CERN)
// All rights reserved.
//
// For the licensing terms see $DD4hepINSTALL/LICENSE.
// For the list of contributors see $DD4hepINSTALL/doc/CREDITS.
//
// Author     : M.Frank
//
//==========================================================================

#ifndef DD4HEP_GEANT4PRIMARY_H
#define DD4HEP_GEANT4PRIMARY_H

// Framework include files
#include "DD4hep/Memory.h"
#include "DDG4/Geant4Vertex.h"
#include "DDG4/Geant4Particle.h"

// C/C++ include files
#include <set>
#include <map>
#include <vector>
#include <memory>

// Forward declarations
class G4PrimaryParticle;

namespace DD4hep {

  namespace Simulation {

    // Forward declarations
    class Geant4Particle;
    class Geant4Vertex;


    class PrimaryExtension  {
    public:
      PrimaryExtension() = default;
      virtual ~PrimaryExtension();
    };


    class Geant4PrimaryMap  {
    public:
      typedef std::map<const G4PrimaryParticle*,Geant4Particle*> Primaries;
    private:
      Primaries       m_primaryMap; 

    public:
      Geant4PrimaryMap() = default;
      virtual ~Geant4PrimaryMap();
      void insert(G4PrimaryParticle* g4_particle,Geant4Particle* particle);
      Geant4Particle* get(const G4PrimaryParticle* particle);
      const Geant4Particle* get(const G4PrimaryParticle* particle) const;
      Primaries& primaries()  {  return m_primaryMap;  }
      const Primaries& primaries() const  {  return m_primaryMap;  }
    };


    /*
     *  \author  M.Frank
     *  \version 1.0
     *  \ingroup DD4HEP_SIMULATION
     */
    class Geant4PrimaryInteraction   {
    private:
      Geant4PrimaryInteraction(const Geant4PrimaryInteraction& c) = delete;
      Geant4PrimaryInteraction& operator=(const Geant4PrimaryInteraction& c) = delete;

    public:
      typedef Geant4Particle                    Particle;
      typedef Geant4Vertex                      Vertex;
      typedef std::map<int,Particle*>           ParticleMap;
      typedef std::map<int,Vertex*>             VertexMap;
      typedef dd4hep_ptr<PrimaryExtension>      ExtensionHandle;

      VertexMap       vertices;
      ParticleMap     particles;
      ExtensionHandle extension;
      int             mask = 0;
      int             locked = 0;
      int             next_particle_identifier = -1;
      
    public:
      Geant4PrimaryInteraction() = default;
      virtual ~Geant4PrimaryInteraction();
      int nextPID();
      void setNextPID(int value);
      bool applyMask();
    };

    /*
     *  Multiple interactions allow a simple handling of overlay events
     *
     *  \author  M.Frank
     *  \version 1.0
     *  \ingroup DD4HEP_SIMULATION
     */
    class Geant4PrimaryEvent   {
    private:
      Geant4PrimaryEvent(const Geant4PrimaryEvent& c) = delete;
      Geant4PrimaryEvent& operator=(const Geant4PrimaryEvent& c) = delete;

    public:
      typedef Geant4PrimaryInteraction     Interaction;
      typedef std::map<int,Interaction*>   Interactions;
      typedef dd4hep_ptr<PrimaryExtension> ExtensionHandle;

    protected:
      Interactions    m_interactions;

    public:
      ExtensionHandle extension;

    public:
      Geant4PrimaryEvent() = default;
      virtual ~Geant4PrimaryEvent();
      void add(int id, Geant4PrimaryInteraction* interaction);
      Geant4PrimaryInteraction* get(int id) const;
      size_t size()  const      {        return m_interactions.size();      }
      std::vector<Geant4PrimaryInteraction*> interactions() const;
    };

  }    // End namespace Simulation
}      // End namespace DD4hep
#endif // DD4HEP_GEANT4PRIMARY_H