altns::ExampleAction Class Reference

#include <ExampleAction.h>

Inheritance diagram for altns::ExampleAction:

Public Member Functions
	ExampleAction ()
virtual	~ExampleAction ()
void	Config (fhicl::ParameterSet const &pset)
	Override Config() to extract any necessary parameters. More...
void	PrintConfig (std::string const &opt)
	Override PrintConfig() to print out current configuration. More...
void	BeginOfEventAction (const G4Event *)
void	EndOfEventAction (const G4Event *)
void	PreTrackingAction (const G4Track *)
	G4UserTrackingAction interfaces. More...
void	PostTrackingAction (const G4Track *)
void	SteppingAction (const G4Step *)
	G4UserSteppingAction interface. More...
bool	ProvidesStacking ()
G4ClassificationOfNewTrack	StackClassifyNewTrack (const G4Track *)
	G4UserStackingAction interfaces. More...
void	StackNewStage ()
void	StackPrepareNewEvent ()
Public Member Functions inherited from g4b::UserAction
	UserAction ()
	UserAction (fhicl::ParameterSet const &pset)
virtual	~UserAction ()
virtual void	BeginOfRunAction (const G4Run *)
	G4UserRunAction interfaces. More...
virtual void	EndOfRunAction (const G4Run *)
std::string const &	GetName () const
void	SetName (std::string const &name)

Private Attributes
double	fSomeValue
	some user config value More...
int	fVerbose
	verbosity More...
int	fStepMsgMaxPerEvt
	shut up about steps More...
int	fTrack2ndMsgMaxPerEvt
	shut up about 2ndary tracks More...
int	fStepMsg
	steps have we printed this evt? More...
int	fTrack2ndMsg
	of 2ndary track printed this evt? More...

Detailed Description

Definition at line 25 of file ExampleAction.h.

Constructor & Destructor Documentation

altns::ExampleAction::ExampleAction

(

)

Create the object

Definition at line 44 of file ExampleAction.cxx.

    : fSomeValue(0)
    , fVerbose(0)
    , fStepMsgMaxPerEvt(42)
    , fTrack2ndMsgMaxPerEvt(2)
  {
    /// Create the object
  }

altns::ExampleAction::~ExampleAction ( )

virtual

Delete anything that we created with "new'.

Definition at line 55 of file ExampleAction.cxx.

  {
    /// Delete anything that we created with "new'.
  }

Member Function Documentation

void altns::ExampleAction::BeginOfEventAction ( const G4Event *  event )

virtual

UserActions method that we'll override, to obtain access to Geant4's particle tracks and trajectories.

This method is invoked before converting the primary particles to G4Track objects. A typical use of this method would be to initialize and/or book histograms for a particular event.

Reimplemented from g4b::UserAction.

Definition at line 85 of file ExampleAction.cxx.

  {
    /// This method is invoked before converting the primary particles
    /// to G4Track objects. A typical use of this method would be to 
    /// initialize and/or book histograms for a particular event.

    mf::LogInfo("ExampleAction")
      << "ExampleAction::BeginOfEventAction EventID="
      << event->GetEventID();

    fStepMsg = 0;
    fTrack2ndMsg = 0;

  }

void altns::ExampleAction::Config ( fhicl::ParameterSet const &  )

virtual

Override Config() to extract any necessary parameters.

Configure the object

Reimplemented from g4b::UserAction.

Definition at line 61 of file ExampleAction.cxx.

  {
    /// Configure the object

    fSomeValue            = pset.get< double >("SomeValue",0)*CLHEP::GeV;
    fVerbose              = pset.get< int    >("Verbose",0);
    fStepMsgMaxPerEvt     = pset.get< int    >("StepMsgMaxPerEvt",42);
    fTrack2ndMsgMaxPerEvt = pset.get< int    >("Track2ndMsgMaxPerEvt",2);

  }

void altns::ExampleAction::EndOfEventAction ( const G4Event *  event )

virtual

This method is invoked at the very end of event processing. It is typically used for a simple analysis of the processed event.

Reimplemented from g4b::UserAction.

Definition at line 101 of file ExampleAction.cxx.

  {
    /// This method is invoked at the very end of event processing.
    /// It is typically used for a simple analysis of the processed event.

    mf::LogInfo("ExampleAction")
      << "ExampleAction::EndOfEventAction EventID="
      << event->GetEventID();
  }

void altns::ExampleAction::PostTrackingAction ( const G4Track *  track )

virtual

This method is invoked after all stepping of this track has occurred

Reimplemented from g4b::UserAction.

Definition at line 127 of file ExampleAction.cxx.

  {
    /// This method is invoked after all stepping of this track
    /// has occurred

    G4int parent_id = track->GetParentID();
    std::string extra_msg = "";
    if ( parent_id > 0 ) {
      ++fTrack2ndMsg;
      if ( fTrack2ndMsg  > fTrack2ndMsgMaxPerEvt ) return;
      if ( fTrack2ndMsg == fTrack2ndMsgMaxPerEvt ) {
        extra_msg = "...last such message this event";
      }
    }

    mf::LogInfo("ExampleAction")
      << "ExampleAction::PostTrackingAction TrackID="
      << track->GetTrackID()
      << " " << extra_msg;
  }

void altns::ExampleAction::PreTrackingAction ( const G4Track *  )

virtual

G4UserTrackingAction interfaces.

This method is invoked before any stepping of this track has occurred

Reimplemented from g4b::UserAction.

Definition at line 112 of file ExampleAction.cxx.

  {
    /// This method is invoked before any stepping of this track
    /// has occurred

    G4int parent_id = track->GetParentID();
    if ( parent_id > 0 && fTrack2ndMsg > fTrack2ndMsgMaxPerEvt ) return;

    mf::LogInfo("ExampleAction")
      << "ExampleAction::PreTrackingAction TrackID="
      << track->GetTrackID()
      << " is a " << track->GetParticleDefinition()->GetParticleName();
  }

void altns::ExampleAction::PrintConfig ( std::string const &  )

virtual

Override PrintConfig() to print out current configuration.

Reimplemented from g4b::UserAction.

Definition at line 73 of file ExampleAction.cxx.

  {
    mf::LogInfo("ExampleAction")
      << "ExampleAction::PrintConfig \n"
      << "    SomeValue            " << fSomeValue            << "\n"
      << "    Verbose              " << fVerbose              << "\n"
      << "    StepMsgMaxPerEvt     " << fStepMsgMaxPerEvt     << "\n"
      << "    Track2ndMsgMaxPerEvt " << fTrack2ndMsgMaxPerEvt << "\n";

  }

bool altns::ExampleAction::ProvidesStacking ( )

inlinevirtual

Does this UserAction do stacking? Override to return "true" if the following interfaces are implemented

Reimplemented from g4b::UserAction.

Definition at line 45 of file ExampleAction.h.

{ return true; } 

G4ClassificationOfNewTrack altns::ExampleAction::StackClassifyNewTrack ( const G4Track *  track )

virtual

G4UserStackingAction interfaces.

This method is invoked by G4StackManager whenever a new G4Track object is "pushed" onto a stack by G4EventManager. ClassifyNewTrack() returns an enumerator, G4ClassificationOfNewTrack, whose value indicates to which stack, if any, the track will be sent. G4ClassificationOfNewTrack has four possible values: fUrgent - track is placed in the urgent stack fWaiting - track is placed in the waiting stack, and will not be simulated until the urgent stack is empty fPostpone - track is postponed to the next event fKill - the track is deleted immediately and not stored in any stack.

Reimplemented from g4b::UserAction.

Definition at line 171 of file ExampleAction.cxx.

  {
    /// This method is invoked by G4StackManager whenever a new G4Track
    /// object is "pushed" onto a stack by G4EventManager. ClassifyNewTrack()
    /// returns an enumerator, G4ClassificationOfNewTrack, whose value 
    /// indicates to which stack, if any, the track will be sent. 
    /// G4ClassificationOfNewTrack has four possible values:
    ///    fUrgent - track is placed in the urgent stack
    ///    fWaiting - track is placed in the waiting stack, 
    ///               and will not be simulated until the urgent stack is empty
    ///    fPostpone - track is postponed to the next event
    ///    fKill - the track is deleted immediately and not stored in any stack.

    G4int parent_id = track->GetParentID();
    std::string tsrc = "primary";
    if ( parent_id < 0 ) tsrc = "postponed (from previous event)";
    if ( parent_id > 0 ) tsrc = "secondary";

    mf::LogInfo("ExampleAction")
      << "ExampleAction::StackClassifyNewTrack TrackID="
      << track->GetTrackID()
      << " ParentID=" << parent_id << " "
      << track->GetDefinition()->GetParticleName()
      << " (" << tsrc << " particle)";

    // One *must* return a classification
    // Since we're not doing anything useful in NewStage/PrepareNewEvent
    // the only things we should return are fUrgent or fKill
    return fUrgent;
  }

void altns::ExampleAction::StackNewStage ( )

virtual

This method is invoked when the urgent stack is empty and the waiting stack contains at least one G4Track object. Here the user may kill or re-assign to different stacks all the tracks in the waiting stack by calling the stackManager->ReClassify() method which, in turn, calls the ClassifyNewTrack() method. If no user action is taken, all tracks in the waiting stack are transferred to the urgent stack. The user may also decide to abort the current event even though some tracks may remain in the waiting stack by calling stackManager->clear(). This method is valid and safe only if it is called from the G4UserStackingAction class.

Reimplemented from g4b::UserAction.

Definition at line 203 of file ExampleAction.cxx.

  {
    /// This method is invoked when the urgent stack is empty and the 
    /// waiting stack contains at least one G4Track object. Here the user
    /// may kill or re-assign to different stacks all the tracks in the
    /// waiting stack by calling the stackManager->ReClassify() method
    /// which, in turn, calls the ClassifyNewTrack() method. If no user
    /// action is taken, all tracks in the waiting stack are transferred
    /// to the urgent stack. The user may also decide to abort the current
    /// event even though some tracks may remain in the waiting stack by 
    /// calling stackManager->clear(). This method is valid and safe only
    /// if it is called from the G4UserStackingAction class.

    mf::LogInfo("ExampleAction")
      << "ExampleAction::StackNewStage";
  }

void altns::ExampleAction::StackPrepareNewEvent ( )

virtual

This method is invoked at the beginning of each event. At this point no primary particles have been converted to tracks, so the urgent and waiting stacks are empty. However, there may be tracks in the postponed-to-next-event stack; for each of these the ClassifyNewTrack() method is called and the track is assigned to the appropriate stack.

Reimplemented from g4b::UserAction.

Definition at line 221 of file ExampleAction.cxx.

  {
    /// This method is invoked at the beginning of each event. At this
    /// point no primary particles have been converted to tracks, so the
    /// urgent and waiting stacks are empty. However, there may be tracks
    /// in the postponed-to-next-event stack; for each of these the 
    /// ClassifyNewTrack() method is called and the track is assigned 
    /// to the appropriate stack.

    mf::LogInfo("ExampleAction")
      << "ExampleAction::StackPrepareNewEvent";
  }

void altns::ExampleAction::SteppingAction ( const G4Step *  )

virtual

G4UserSteppingAction interface.

This method is invoked at each end of stepping

Reimplemented from g4b::UserAction.

Definition at line 149 of file ExampleAction.cxx.

  {
    /// This method is invoked at each end of stepping

    ++fStepMsg;
    if ( ++fStepMsg > fStepMsgMaxPerEvt ) return;

    std::string extra_msg = "";
    if ( fStepMsg == fStepMsgMaxPerEvt ) {
      extra_msg = "...last such message this event";
    }

    mf::LogInfo("ExampleAction")
      << "ExampleAction::SteppingAction TrackID="
      << step->GetTrack()->GetTrackID()
      << " " << extra_msg;


  }

Member Data Documentation

double altns::ExampleAction::fSomeValue

private

some user config value

Definition at line 53 of file ExampleAction.h.

int altns::ExampleAction::fStepMsg

private

steps have we printed this evt?

Definition at line 58 of file ExampleAction.h.

int altns::ExampleAction::fStepMsgMaxPerEvt

private

shut up about steps

Definition at line 55 of file ExampleAction.h.

int altns::ExampleAction::fTrack2ndMsg

private

of 2ndary track printed this evt?

Definition at line 59 of file ExampleAction.h.

int altns::ExampleAction::fTrack2ndMsgMaxPerEvt

private

shut up about 2ndary tracks

Definition at line 56 of file ExampleAction.h.

int altns::ExampleAction::fVerbose

private

verbosity

Definition at line 54 of file ExampleAction.h.

---

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

• nutools/old/G4Base/ExampleAction.h
• nutools/old/G4Base/ExampleAction.cxx