PrimaryGeneratorActionBase.hh

Go to the documentation of this file.

// This file is the header for the @PrimaryGeneratorActionBase@ class.

// A base class for Geant user primary generator action

// @GeneratePrimaries@ - This method, which takes a pointer to a @G4Event@
// object, is called to create the primary particle(s) for an event. It is
// called once at the beginning of each event. Putting code in this method of
// and action object is equivalent to putting it in the @GeneratePrimaries@
// method of the simulation's primary generator action class.

#ifndef artg4tk_actionBase_PrimaryGeneratorActionBase_hh
#define artg4tk_actionBase_PrimaryGeneratorActionBase_hh

#include <string>

#include "artg4tk/actionBase/ActionBase.hh"

// Declarations of types we use as input parameters
class G4Event;

// Everything goes in the Art G4 namespace
namespace artg4tk {

  class PrimaryGeneratorActionBase : public ActionBase {
  public:
    // Constructor. The derived class must call this constructor. It takes a
    // single string for the name of the action object.
    explicit PrimaryGeneratorActionBase(std::string name);

    virtual ~PrimaryGeneratorActionBase();

    // h3. The interesting methods.
    // All of these are defined to do nothing by default. Users can override
    // them if desired, and if they're not overloaded, they do nothing.

    // Called for the generation of primaries
    virtual void
    generatePrimaries(G4Event*)
    {}
  };
}

#endif /* artg4tk_actionBase_PrimaryGeneratorActionBase_hh */