GGSUserActionsManager Class Reference

The GGS ser actions manager. More...

#include <GGSUserActionsManager.h>

Inheritance diagram for GGSUserActionsManager:

Collaboration diagram for GGSUserActionsManager:

Public Member Functions
	~GGSUserActionsManager ()
	Destructor. More...
void	AddAction (GGSUserAction *userAction)
	Adds a general user action. More...
void	AddAction (G4UserSteppingAction *steppingAction)
	Adds a stepping action. More...
void	AddAction (G4UserTrackingAction *trackingAction)
	Adds a tracking action. More...
void	AddAction (G4UserEventAction *eventAction)
	Adds a event action. More...
void	AddAction (G4UserRunAction *runAction)
	Adds a run action. More...
void	AddAction (G4UserStackingAction *stackingAction)
	Adds a stacking action. More...
void	UserSteppingAction (const G4Step *step)
	Override of UserSteppingAction method. More...
void	PreUserTrackingAction (const G4Track *track)
	Override of PreUserTrackingAction method. More...
void	PostUserTrackingAction (const G4Track *track)
	Override of PostUserTrackingAction method. More...
void	BeginOfEventAction (const G4Event *event)
	Override of BeginOfEventAction method. More...
void	EndOfEventAction (const G4Event *event)
	Override of EndOfEventAction method. More...
void	BeginOfRunAction (const G4Run *run)
	Override of BeginOfRunAction method. More...
void	EndOfRunAction (const G4Run *run)
	Override of EndOfRunAction method. More...
G4ClassificationOfNewTrack	ClassifyNewTrack (const G4Track *aTrack)
	Override of ClassifyNewTrack method. More...
void	NewStage ()
	Override of NewStage method. More...
void	PrepareNewEvent ()
	Override of PrepareNewEvent method. More...
Public Member Functions inherited from GGSUserAction
	GGSUserAction ()
	Constructor. More...
virtual	~GGSUserAction ()
	Destructor.
G4ClassificationOfNewTrack	ClassifyNewTrack (const G4Track *)
	Override of the ClassifyNewTrack method. More...

Static Public Member Functions
static GGSUserActionsManager *	GetInstance ()
	Get the singleton instance. More...

Detailed Description

The GGS ser actions manager.

This class is intended as an actions container. User can fill it with desired actions and the manager will provide the necessary interface to GEANT4 kernel calls. The main aim of this software layer is to give the user the possibility to define and use the set of actions which is most suitable for the specific simulation. The manager can contain general actions inheriting from GGSUserAction (which can do something at each simulation level) as well as actions inheriting from regular GEANT4 user actions (like G4UserEventAction, which acts only at the beginning and at the end of an event. The actions are NOT guaranteed to be executed in the same order they are added to the manager. The manager in current implementation owns the actions; this means that when the manager is destroyed it will delete all the actions it contains.

Definition at line 32 of file GGSUserActionsManager.h.

Constructor & Destructor Documentation

GGSUserActionsManager::~GGSUserActionsManager

(

)

Destructor.

It destroys also the actions previously added to the manager.

Definition at line 33 of file GGSUserActionsManager.cpp.

                                              {

  // Delete general actions
  for (unsigned int i = 0; i < _userActions.size(); i++)
    if (_userActions[i]) {
      delete _userActions[i];
    }
  // Delete stepping actions
  for (unsigned int i = 0; i < _steppingActions.size(); i++)
    if (_steppingActions[i]) {
      delete _steppingActions[i];
    }
  // Delete tracking actions
  for (unsigned int i = 0; i < _trackingActions.size(); i++)
    if (_trackingActions[i]) {
      delete _trackingActions[i];
    }
  // Delete event actions
  for (unsigned int i = 0; i < _eventActions.size(); i++)
    if (_eventActions[i]) {
      delete _eventActions[i];
    }
  // Delete run actions
  for (unsigned int i = 0; i < _runActions.size(); i++)
    if (_runActions[i]) {
      delete _runActions[i];
    }

  // Warning: this destructor will be called by ~G4Manager, which runs after
  //          ~GGSRunManager. So at this stage the child GGSRunManager is no
  //          more available and thus the mother G4Manager must be referenced.
  // TODO: handle the destruction of the actions manager inside ~GGSRunManager, when
  //       the GGSRunManager interface has been properly extended to handle the
  //       actions manager.
  G4RunManager *runManager = G4RunManager::GetRunManager();
  if (runManager->GetUserSteppingAction() == this)
    runManager->SetUserAction((G4UserSteppingAction *)0);
  if (runManager->GetUserTrackingAction() == this)
    runManager->SetUserAction((G4UserTrackingAction *)0);
  if (runManager->GetUserEventAction() == this)
    runManager->SetUserAction((G4UserEventAction *)0);
  if (runManager->GetUserRunAction() == this)
    runManager->SetUserAction((G4UserRunAction *)0);
  if (runManager->GetUserStackingAction() == this)
    runManager->SetUserAction((G4UserStackingAction *)0);

  // delete messenger
  delete _messenger;
}

Member Function Documentation

void GGSUserActionsManager::AddAction

(

GGSUserAction *

userAction

)

Adds a general user action.

Parameters

userAction

The general user action to be added to the manager.

Definition at line 85 of file GGSUserActionsManager.cpp.

                                                               {
  if (userAction) {
    _userActions.push_back(userAction);
    _userActions.back()->SetTrackingManagerPointer(fpTrackingManager);
  }
}

void GGSUserActionsManager::AddAction

(

G4UserSteppingAction *

steppingAction

)

Adds a stepping action.

Parameters

steppingAction

The stepping action to be added to the manager.

Definition at line 94 of file GGSUserActionsManager.cpp.

                                                                          {
  if (steppingAction)
    _steppingActions.push_back(steppingAction);
}

void GGSUserActionsManager::AddAction

(

G4UserTrackingAction *

trackingAction

)

Adds a tracking action.

Parameters

trackingAction

The tracking action to be added to the manager.

Definition at line 101 of file GGSUserActionsManager.cpp.

                                                                          {
  if (trackingAction) {
    _trackingActions.push_back(trackingAction);
    _trackingActions.back()->SetTrackingManagerPointer(fpTrackingManager);
  }
}

void GGSUserActionsManager::AddAction

(

G4UserEventAction *

eventAction

)

Adds a event action.

Parameters

eventAction

The event action to be added to the manager.

Definition at line 110 of file GGSUserActionsManager.cpp.

                                                                    {
  if (eventAction)
    _eventActions.push_back(eventAction);
}

void GGSUserActionsManager::AddAction

(

G4UserRunAction *

runAction

)

Adds a run action.

Parameters

runAction

The run action to be added to the manager.

Definition at line 117 of file GGSUserActionsManager.cpp.

                                                                {
  if (runAction)
    _runActions.push_back(runAction);
}

void GGSUserActionsManager::AddAction

(

G4UserStackingAction *

stackingAction

)

Adds a stacking action.

Parameters

stackingAction

The stacking action to be added to the manager.

void GGSUserActionsManager::BeginOfEventAction

(

const G4Event *

event

)

Override of BeginOfEventAction method.

This routine calls BeginOfEventAction for every general and event actions in the manager.

Parameters

event

The current event.

Definition at line 163 of file GGSUserActionsManager.cpp.

                                                                   {

  // Call routine for general actions
  for (unsigned int i = 0; i < _userActions.size(); i++)
    _userActions[i]->BeginOfEventAction(event);

  // Call routine for event actions
  for (unsigned int i = 0; i < _eventActions.size(); i++)
    _eventActions[i]->BeginOfEventAction(event);
}

void GGSUserActionsManager::BeginOfRunAction

(

const G4Run *

run

)

Override of BeginOfRunAction method.

This routine calls BeginOfRunAction for every general and run actions in the manager.

Parameters

run	The current run.

Definition at line 194 of file GGSUserActionsManager.cpp.

                                                             {

  // Call routine for general actions
  for (unsigned int i = 0; i < _userActions.size(); i++)
    _userActions[i]->BeginOfRunAction(run);

  // Call routine for run actions
  for (unsigned int i = 0; i < _runActions.size(); i++)
    _runActions[i]->BeginOfRunAction(run);
}

G4ClassificationOfNewTrack GGSUserActionsManager::ClassifyNewTrack

(

const G4Track *

aTrack

)

Override of ClassifyNewTrack method.

This routine calls ClassifyNewTrack for every general actions in the manager. If no general actions are present, or if none of them reimplements ClassifyNewTrack properly, it returns the return value of G4UserStackingAction::ClassifyNewTrack. If more actions are present and the classifications are not in agreement, the default classification given by G4UserStackingAction::ClassifyNewTrack will be returned;

Parameters

aTrack

The new track.

Definition at line 220 of file GGSUserActionsManager.cpp.

                                                                                        {

  int classif, actionClassif;
  classif = -100;

  for (unsigned int i = 0; i < _userActions.size(); i++) {
    actionClassif = _userActions[i]->ClassifyNewTrack(aTrack);
    if (actionClassif != -100) {
      if (actionClassif != classif && classif != -100) {
        return G4UserStackingAction::ClassifyNewTrack(aTrack);
      } else
        classif = actionClassif;
    }
  }
  if (classif == -100)
    return G4UserStackingAction::ClassifyNewTrack(aTrack);
  else
    return (G4ClassificationOfNewTrack)classif;
}

void GGSUserActionsManager::EndOfEventAction

(

const G4Event *

event

)

Override of EndOfEventAction method.

This routine calls EndOfEventAction for every general and event actions in the manager.

Parameters

event

The current event.

Definition at line 176 of file GGSUserActionsManager.cpp.

                                                                 {

  if (!GGSRunManager::GetRunManager()->IsCurrentEventKilled()) {

    // Call routine for general actions
    for (unsigned int i = 0; i < _userActions.size(); i++)
      _userActions[i]->EndOfEventAction(event);

    // Call routine for event actions
    for (unsigned int i = 0; i < _eventActions.size(); i++)
      _eventActions[i]->EndOfEventAction(event);

    GGSRootFileService::GetInstance()._FillDefaultEventsTrees();
  }
}

void GGSUserActionsManager::EndOfRunAction

(

const G4Run *

run

)

Override of EndOfRunAction method.

This routine calls EndOfRunAction for every general and run actions in the manager.

Parameters

run	The current run.

Definition at line 207 of file GGSUserActionsManager.cpp.

                                                           {

  // Call routine for general actions
  for (unsigned int i = 0; i < _userActions.size(); i++)
    _userActions[i]->EndOfRunAction(run);

  // Call routine for run actions
  for (unsigned int i = 0; i < _runActions.size(); i++)
    _runActions[i]->EndOfRunAction(run);
}

GGSUserActionsManager * GGSUserActionsManager::GetInstance ( )

static

Get the singleton instance.

This method instantiate the singleton when it is first called. Every access to the manager must be done using the returned pointer.

Returns

A pointer to the singleton instance of GGSUserActionsManager.

Definition at line 20 of file GGSUserActionsManager.cpp.

                                                          {
  if (!_instance)
    _instance = new GGSUserActionsManager();

  return _instance;
}

void GGSUserActionsManager::NewStage

(

)

Override of NewStage method.

This routine calls NewStage for every general and stacking actions in the manager.

Definition at line 242 of file GGSUserActionsManager.cpp.

                                     {
  for (unsigned int i = 0; i < _userActions.size(); i++) {
    _userActions[i]->NewStage();
  }
}

void GGSUserActionsManager::PostUserTrackingAction

(

const G4Track *

track

)

Override of PostUserTrackingAction method.

This routine calls PostUserTrackingAction for every general and tracking actions in the manager.

Parameters

track

The current track.

Definition at line 150 of file GGSUserActionsManager.cpp.

                                                                       {

  // Call routine for general actions
  for (unsigned int i = 0; i < _userActions.size(); i++)
    _userActions[i]->PostUserTrackingAction(track);

  // Call routine for tracking actions
  for (unsigned int i = 0; i < _trackingActions.size(); i++)
    _trackingActions[i]->PostUserTrackingAction(track);
}

void GGSUserActionsManager::PrepareNewEvent

(

)

Override of PrepareNewEvent method.

This routine calls PrepareNewEvent for every general and stacking actions in the manager.

Definition at line 250 of file GGSUserActionsManager.cpp.

                                            {

  for (unsigned int i = 0; i < _userActions.size(); i++) {
    _userActions[i]->PrepareNewEvent();
  }
}

void GGSUserActionsManager::PreUserTrackingAction

(

const G4Track *

track

)

Override of PreUserTrackingAction method.

This routine calls PreUserTrackingAction for every general and tracking actions in the manager.

Parameters

track

The current track.

Definition at line 137 of file GGSUserActionsManager.cpp.

                                                                      {

  // Call routine for general actions
  for (unsigned int i = 0; i < _userActions.size(); i++)
    _userActions[i]->PreUserTrackingAction(track);

  // Call routine for tracking actions
  for (unsigned int i = 0; i < _trackingActions.size(); i++)
    _trackingActions[i]->PreUserTrackingAction(track);
}

void GGSUserActionsManager::UserSteppingAction

(

const G4Step *

step

)

Override of UserSteppingAction method.

This routine calls UserSteppingAction for every general and stepping actions in the manager.

Parameters

step	The current step.

Definition at line 124 of file GGSUserActionsManager.cpp.

                                                                 {

  // Call routine for general actions
  for (unsigned int i = 0; i < _userActions.size(); i++)
    _userActions[i]->UserSteppingAction(step);

  // Call routine for stepping actions
  for (unsigned int i = 0; i < _steppingActions.size(); i++)
    _steppingActions[i]->UserSteppingAction(step);
}

---

The documentation for this class was generated from the following files:

• GGSUserActionsManager.h
• GGSUserActionsManager.cpp