Ex01MCStack Class Reference

Implementation of the TVirtualMCStack interface. More...

#include <Ex01MCStack.h>

Inheritance diagram for Ex01MCStack:

Public Member Functions
	Ex01MCStack (Int_t size)
	Ex01MCStack ()
virtual	~Ex01MCStack ()
virtual void	PushTrack (Int_t toBeDone, Int_t parent, Int_t pdg, Double_t px, Double_t py, Double_t pz, Double_t e, Double_t vx, Double_t vy, Double_t vz, Double_t tof, Double_t polx, Double_t poly, Double_t polz, TMCProcess mech, Int_t &ntr, Double_t weight, Int_t is)
virtual TParticle *	PopNextTrack (Int_t &itrack)
virtual TParticle *	PopPrimaryForTracking (Int_t i)
virtual void	SetCurrentTrack (Int_t itrack)
virtual Int_t	GetNtrack () const
virtual Int_t	GetNprimary () const
virtual TParticle *	GetCurrentTrack () const
virtual Int_t	GetCurrentTrackNumber () const
virtual Int_t	GetCurrentParentTrackNumber () const

Private Member Functions
Ex01Particle *	GetParticle (Int_t id) const

Private Attributes
std::stack< Ex01Particle * >	fStack
	The stack of particles (transient)
TObjArray *	fParticles
	The array of particle (persistent)
Int_t	fCurrentTrack
	The current track number.
Int_t	fNPrimary
	The number of primaries.

Detailed Description

Implementation of the TVirtualMCStack interface.

Date

05/04/2002

Author

I. Hrivnacova; IPN, Orsay

Definition at line 32 of file Ex01MCStack.h.

Constructor & Destructor Documentation

Ex01MCStack() [1/2]

Ex01MCStack::Ex01MCStack

(

Int_t

size

)

Standard constructor

Parameters

size	The stack size

Definition at line 29 of file Ex01MCStack.cxx.

  : fParticles(0), fCurrentTrack(-1), fNPrimary(0)
{
  /// Standard constructor
  /// \param size  The stack size
 
  fParticles = new TObjArray(size);
}

Ex01MCStack() [2/2]

Ex01MCStack::Ex01MCStack

(

)

Default constructor

Definition at line 39 of file Ex01MCStack.cxx.

                         : fParticles(0), fCurrentTrack(-1), fNPrimary(0)
{
  /// Default constructor
}

~Ex01MCStack()

Ex01MCStack::~Ex01MCStack ( )

virtual

Destructor

Definition at line 45 of file Ex01MCStack.cxx.

{
  /// Destructor
 
  if (fParticles) fParticles->Delete();
  delete fParticles;
}

Member Function Documentation

PushTrack()

void Ex01MCStack::PushTrack ( Int_t toBeDone, Int_t parent, Int_t pdg, Double_t px, Double_t py, Double_t pz, Double_t e, Double_t vx, Double_t vy, Double_t vz, Double_t tof, Double_t polx, Double_t poly, Double_t polz, TMCProcess mech, Int_t & ntr, Double_t weight, Int_t is )

virtual

Create a new particle and push into stack; adds it to the particles array (fParticles) and if not done to the stack (fStack).

Parameters

toBeDone	1 if particles should go to tracking, 0 otherwise
parent	number of the parent track, -1 if track is primary
pdg	PDG encoding
px	particle momentum - x component [GeV/c]
py	particle momentum - y component [GeV/c]
pz	particle momentum - z component [GeV/c]
e	total energy [GeV]
vx	position - x component [cm]
vy	position - y component [cm]
vz	position - z component [cm]
tof	time of flight [s]
polx	polarization - x component
poly	polarization - y component
polz	polarization - z component
mech	creator process VMC code
ntr	track number (is filled by the stack
weight	particle weight
is	generation status code

Definition at line 70 of file Ex01MCStack.cxx.

{
  /// Create a new particle and push into stack;
  /// adds it to the particles array (fParticles) and if not done to the
  /// stack (fStack).
  /// \param toBeDone  1 if particles should go to tracking, 0 otherwise
  /// \param parent    number of the parent track, -1 if track is primary
  /// \param pdg       PDG encoding
  /// \param px        particle momentum - x component [GeV/c]
  /// \param py        particle momentum - y component [GeV/c]
  /// \param pz        particle momentum - z component [GeV/c]
  /// \param e         total energy [GeV]
  /// \param vx        position - x component [cm]
  /// \param vy        position - y component  [cm]
  /// \param vz        position - z component  [cm]
  /// \param tof       time of flight [s]
  /// \param polx      polarization - x component
  /// \param poly      polarization - y component
  /// \param polz      polarization - z component
  /// \param mech      creator process VMC code
  /// \param ntr       track number (is filled by the stack
  /// \param weight    particle weight
  /// \param is        generation status code
 
  const Int_t kFirstDaughter = -1;
  const Int_t kLastDaughter = -1;
 
  TParticle* particleDef = new TParticle(pdg, is, parent, -1, kFirstDaughter,
    kLastDaughter, px, py, pz, e, vx, vy, vz, tof);
 
  particleDef->SetPolarisation(polx, poly, polz);
  particleDef->SetWeight(weight);
  particleDef->SetUniqueID(mech);
 
  Ex01Particle* mother = 0;
  if (parent >= 0)
    mother = GetParticle(parent);
  else
    fNPrimary++;
 
  Ex01Particle* particle = new Ex01Particle(GetNtrack(), particleDef, mother);
 
  fParticles->Add(particle);
 
  if (toBeDone) fStack.push(particle);
 
  ntr = GetNtrack() - 1;
}

PopNextTrack()

TParticle * Ex01MCStack::PopNextTrack ( Int_t & itrack )

virtual

Get next particle for tracking from the stack.

Returns

The popped particle object

Parameters

itrack

The index of the popped track

Definition at line 123 of file Ex01MCStack.cxx.

{
  /// Get next particle for tracking from the stack.
  /// \return        The popped particle object
  /// \param itrack  The index of the popped track
 
  itrack = -1;
  if (fStack.empty()) return 0;
 
  Ex01Particle* particle = fStack.top();
  fStack.pop();
 
  if (!particle) return 0;
 
  itrack = particle->GetID();
  fCurrentTrack = itrack;
 
  return particle->GetParticle();
}

PopPrimaryForTracking()

TParticle * Ex01MCStack::PopPrimaryForTracking ( Int_t i )

virtual

Return i -th particle in fParticles.

Returns

The popped primary particle object

Parameters

i	The index of primary particle to be popped

Definition at line 144 of file Ex01MCStack.cxx.

{
  /// Return \em i -th particle in fParticles.
  /// \return   The popped primary particle object
  /// \param i  The index of primary particle to be popped
 
  if (i < 0 || i >= fNPrimary)
    Fatal("GetPrimaryForTracking", "Index out of range");
 
  return ((Ex01Particle*)fParticles->At(i))->GetParticle();
}

SetCurrentTrack()

void Ex01MCStack::SetCurrentTrack ( Int_t itrack )

virtual

Set the current track number to a given value.

Parameters

itrack

The current track number

Definition at line 157 of file Ex01MCStack.cxx.

{
  /// Set the current track number to a given value.
  /// \param  itrack The current track number
 
  fCurrentTrack = itrack;
}

GetNtrack()

Int_t Ex01MCStack::GetNtrack ( ) const

virtual

Returns

The total number of all tracks.

Definition at line 166 of file Ex01MCStack.cxx.

{
  /// \return  The total number of all tracks.
 
  return fParticles->GetEntriesFast();
}

GetNprimary()

Int_t Ex01MCStack::GetNprimary ( ) const

virtual

Returns

The total number of primary tracks.

Definition at line 174 of file Ex01MCStack.cxx.

{
  /// \return  The total number of primary tracks.
 
  return fNPrimary;
}

GetCurrentTrack()

TParticle * Ex01MCStack::GetCurrentTrack ( ) const

virtual

Returns

The current track particle

Definition at line 182 of file Ex01MCStack.cxx.

{
  /// \return  The current track particle
 
  Ex01Particle* current = GetParticle(fCurrentTrack);
 
  if (current)
    return current->GetParticle();
  else
    return 0;
}

GetCurrentTrackNumber()

Int_t Ex01MCStack::GetCurrentTrackNumber ( ) const

virtual

Returns

The current track number

Definition at line 195 of file Ex01MCStack.cxx.

{
  /// \return  The current track number
 
  return fCurrentTrack;
}

GetCurrentParentTrackNumber()

Int_t Ex01MCStack::GetCurrentParentTrackNumber ( ) const

virtual

Returns

The current track parent ID.

Definition at line 202 of file Ex01MCStack.cxx.

{
  /// \return  The current track parent ID.
 
  Ex01Particle* current = GetParticle(fCurrentTrack);
 
  if (!current) return -1;
 
  Ex01Particle* mother = current->GetMother();
 
  if (!mother) return -1;
 
  return mother->GetID();
}

GetParticle()

Ex01Particle * Ex01MCStack::GetParticle ( Int_t id ) const

private

Returns

The id -th particle in fParticles

Parameters

id	The index of the particle to be returned

Definition at line 56 of file Ex01MCStack.cxx.

{
  /// \return   The \em id -th particle in fParticles
  /// \param id The index of the particle to be returned
 
  if (id < 0 || id >= fParticles->GetEntriesFast())
    Fatal("GetParticle", "Index out of range");
 
  return (Ex01Particle*)fParticles->At(id);
}

Member Data Documentation

fStack

std::stack<Ex01Particle*> Ex01MCStack::fStack

private

The stack of particles (transient)

Definition at line 62 of file Ex01MCStack.h.

fParticles

TObjArray* Ex01MCStack::fParticles

private

The array of particle (persistent)

Definition at line 63 of file Ex01MCStack.h.

fCurrentTrack

Int_t Ex01MCStack::fCurrentTrack

private

The current track number.

Definition at line 64 of file Ex01MCStack.h.

fNPrimary

Int_t Ex01MCStack::fNPrimary

private

The number of primaries.

Definition at line 65 of file Ex01MCStack.h.

---

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

• examples/E01/include/Ex01MCStack.h
• examples/E01/src/Ex01MCStack.cxx