simcore::g4user::StackingAction Class Reference

Class implementing a user stacking action. More...

#include <StackingAction.h>

Public Member Functions
	StackingAction ()=default
	Constructor.
virtual	~StackingAction ()=default
	Destructor.
G4ClassificationOfNewTrack	ClassifyNewTrack (const G4Track *track) override
	Classify a new track.
void	NewStage () override
	Invoked when there is a new stacking stage.
void	PrepareNewEvent () override
	Invoked for a new event.
void	registerAction (std::shared_ptr< UserAction > stackingAction)
	Register a user action of type stacking action with this class.

Private Attributes
std::vector< std::shared_ptr< UserAction > >	stacking_actions_
	Collection of user stacking actions.

Detailed Description

Class implementing a user stacking action.

Definition at line 32 of file StackingAction.h.

Member Function Documentation

ClassifyNewTrack()

G4ClassificationOfNewTrack simcore::g4user::StackingAction::ClassifyNewTrack ( const G4Track * track )

override

Classify a new track.

Parameters

aTrack

The track to classify.

Returns

The track classification.

Definition at line 6 of file StackingAction.cxx.

                          {
  // Default value of a track is fUrgent.
  G4ClassificationOfNewTrack current_track_class =
      G4ClassificationOfNewTrack::fUrgent;
 
  // Get proposed new track classification from this plugin.
  for (auto& stacking_action : stacking_actions_) {
    // Get proposed new track classification from this plugin.
    G4ClassificationOfNewTrack new_track_class =
        stacking_action->ClassifyNewTrack(track, current_track_class);
 
    // Only set the current classification if the plugin changed it.
    if (new_track_class != current_track_class)
      current_track_class = new_track_class;
  }
 
  return current_track_class;
}

References stacking_actions_.

NewStage()

void simcore::g4user::StackingAction::NewStage ( )

override

Invoked when there is a new stacking stage.

Definition at line 26 of file StackingAction.cxx.

                              {
  for (auto& stacking_action : stacking_actions_) stacking_action->NewStage();
}

References stacking_actions_.

PrepareNewEvent()

void simcore::g4user::StackingAction::PrepareNewEvent ( )

override

Invoked for a new event.

Definition at line 30 of file StackingAction.cxx.

                                     {
  for (auto& stacking_action : stacking_actions_)
    stacking_action->PrepareNewEvent();
}

References stacking_actions_.

registerAction()

void simcore::g4user::StackingAction::registerAction ( std::shared_ptr< UserAction > stackingAction )

inline

Register a user action of type stacking action with this class.

Parameters

action

User action of type StackingAction

Definition at line 62 of file StackingAction.h.

                                                                {
    stacking_actions_.push_back(stackingAction);
  }

References stacking_actions_.

Member Data Documentation

stacking_actions_

std::vector<std::shared_ptr<UserAction> > simcore::g4user::StackingAction::stacking_actions_

private

Collection of user stacking actions.

Definition at line 68 of file StackingAction.h.

Referenced by ClassifyNewTrack(), NewStage(), PrepareNewEvent(), and registerAction().

---

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

• SimCore/include/SimCore/G4User/StackingAction.h
• SimCore/src/SimCore/G4User/StackingAction.cxx