Logo ROOT   6.19/01
Reference Guide
TVirtualMCApplication Class Referenceabstract

Interface to a user Monte Carlo application.

Definition at line 29 of file TVirtualMCApplication.h.

Public Member Functions

 TVirtualMCApplication (const char *name, const char *title)
 Standard constructor. More...
 
 TVirtualMCApplication ()
 Default constructor. More...
 
virtual ~TVirtualMCApplication ()
 Destructor. More...
 
virtual void AddIons ()
 Add user defined ions (optional) More...
 
virtual void AddParticles ()
 Add user defined particles (optional) More...
 
virtual void BeginEvent ()=0
 Define actions at the beginning of the event. More...
 
virtual void BeginPrimary ()=0
 Define actions at the beginning of the primary track. More...
 
virtual void BeginRunOnWorker ()
 Define actions at the beginning of the worker run if needed. More...
 
virtual void BeginWorkerRun () const
 Const Define actions at the beginning of the worker run if needed - now deprecated Use new non-const BeginRunOnWorker() instead. More...
 
virtual TVirtualMCApplicationCloneForWorker () const
 Clone MC application on worker. More...
 
virtual void ConstructGeometry ()=0
 Construct user geometry. More...
 
virtual void ConstructOpGeometry ()
 Define parameters for optical processes (optional) More...
 
virtual void ConstructSensitiveDetectors ()
 Define sensitive detectors (optional) More...
 
virtual void EndOfEvent ()
 Define actions at the end of the event before calling SD's end of the event. More...
 
virtual void Field (const Double_t *x, Double_t *b) const
 Calculate user field b at point x. More...
 
virtual void FinishEvent ()=0
 Define actions at the end of the event. More...
 
virtual void FinishPrimary ()=0
 Define actions at the end of the primary track. More...
 
virtual void FinishRunOnWorker ()
 Define actions at the end of the worker run if needed. More...
 
virtual void FinishWorkerRun () const
 Const Define actions at the end of the worker run if needed - now deprecated Use new non-const FinishRunOnWorker() instead. More...
 
virtual void GeaneStepping ()
 Define action at each step for Geane. More...
 
virtual void GeneratePrimaries ()=0
 Generate primary particles. More...
 
TVirtualMCGetMC () const
 Return the transport engine registered to this application. More...
 
virtual void InitForWorker () const
 Const Initialize MC application on worker - now deprecated Use new non-const InitOnWorker() instead. More...
 
virtual void InitGeometry ()=0
 Initialize geometry (Usually used to define sensitive volumes IDs) More...
 
virtual void InitOnWorker ()
 Initialize MC application on worker. More...
 
virtual void Merge (TVirtualMCApplication *)
 Merge the data accumulated on workers to the master if needed. More...
 
virtual Bool_t MisalignGeometry ()
 Misalign user geometry (optional) More...
 
virtual void PostTrack ()=0
 Define actions at the end of each track. More...
 
virtual void PreTrack ()=0
 Define actions at the beginning of each track. More...
 
void Register (TVirtualMC *mc)
 Register the an engine. More...
 
void RequestMCManager ()
 Request a TMCManager which is required if multiple engines should be run. More...
 
virtual void Stepping ()=0
 Define action at each step. More...
 
virtual Double_t TrackingRmax () const
 Define maximum radius for tracking (optional) More...
 
virtual Double_t TrackingZmax () const
 Define maximum z for tracking (optional) More...
 
- Public Member Functions inherited from TNamed
 TNamed ()
 
 TNamed (const char *name, const char *title)
 
 TNamed (const TString &name, const TString &title)
 
 TNamed (const TNamed &named)
 TNamed copy ctor. More...
 
virtual ~TNamed ()
 TNamed destructor. More...
 
virtual void Clear (Option_t *option="")
 Set name and title to empty strings (""). More...
 
virtual TObjectClone (const char *newname="") const
 Make a clone of an object using the Streamer facility. More...
 
virtual Int_t Compare (const TObject *obj) const
 Compare two TNamed objects. More...
 
virtual void Copy (TObject &named) const
 Copy this to obj. More...
 
virtual void FillBuffer (char *&buffer)
 Encode TNamed into output buffer. More...
 
virtual const char * GetName () const
 Returns name of object. More...
 
virtual const char * GetTitle () const
 Returns title of object. More...
 
virtual ULong_t Hash () const
 Return hash value for this object. More...
 
virtual Bool_t IsSortable () const
 
virtual void ls (Option_t *option="") const
 List TNamed name and title. More...
 
TNamedoperator= (const TNamed &rhs)
 TNamed assignment operator. More...
 
virtual void Print (Option_t *option="") const
 Print TNamed name and title. More...
 
virtual void SetName (const char *name)
 Set the name of the TNamed. More...
 
virtual void SetNameTitle (const char *name, const char *title)
 Set all the TNamed parameters (name and title). More...
 
virtual void SetTitle (const char *title="")
 Set the title of the TNamed. More...
 
virtual Int_t Sizeof () const
 Return size of the TNamed part of the TObject. More...
 
- Public Member Functions inherited from TObject
 TObject ()
 TObject constructor. More...
 
 TObject (const TObject &object)
 TObject copy ctor. More...
 
virtual ~TObject ()
 TObject destructor. More...
 
void AbstractMethod (const char *method) const
 Use this method to implement an "abstract" method that you don't want to leave purely abstract. More...
 
virtual void AppendPad (Option_t *option="")
 Append graphics object to current pad. More...
 
virtual void Browse (TBrowser *b)
 Browse object. May be overridden for another default action. More...
 
ULong_t CheckedHash ()
 Check and record whether this class has a consistent Hash/RecursiveRemove setup (*) and then return the regular Hash value for this object. More...
 
virtual const char * ClassName () const
 Returns name of class to which the object belongs. More...
 
virtual void Delete (Option_t *option="")
 Delete this object. More...
 
virtual Int_t DistancetoPrimitive (Int_t px, Int_t py)
 Computes distance from point (px,py) to the object. More...
 
virtual void Draw (Option_t *option="")
 Default Draw method for all objects. More...
 
virtual void DrawClass () const
 Draw class inheritance tree of the class to which this object belongs. More...
 
virtual TObjectDrawClone (Option_t *option="") const
 Draw a clone of this object in the current selected pad for instance with: gROOT->SetSelectedPad(gPad). More...
 
virtual void Dump () const
 Dump contents of object on stdout. More...
 
virtual void Error (const char *method, const char *msgfmt,...) const
 Issue error message. More...
 
virtual void Execute (const char *method, const char *params, Int_t *error=0)
 Execute method on this object with the given parameter string, e.g. More...
 
virtual void Execute (TMethod *method, TObjArray *params, Int_t *error=0)
 Execute method on this object with parameters stored in the TObjArray. More...
 
virtual void ExecuteEvent (Int_t event, Int_t px, Int_t py)
 Execute action corresponding to an event at (px,py). More...
 
virtual void Fatal (const char *method, const char *msgfmt,...) const
 Issue fatal error message. More...
 
virtual TObjectFindObject (const char *name) const
 Must be redefined in derived classes. More...
 
virtual TObjectFindObject (const TObject *obj) const
 Must be redefined in derived classes. More...
 
virtual Option_tGetDrawOption () const
 Get option used by the graphics system to draw this object. More...
 
virtual const char * GetIconName () const
 Returns mime type name of object. More...
 
virtual char * GetObjectInfo (Int_t px, Int_t py) const
 Returns string containing info about the object at position (px,py). More...
 
virtual Option_tGetOption () const
 
virtual UInt_t GetUniqueID () const
 Return the unique object id. More...
 
virtual Bool_t HandleTimer (TTimer *timer)
 Execute action in response of a timer timing out. More...
 
Bool_t HasInconsistentHash () const
 Return true is the type of this object is known to have an inconsistent setup for Hash and RecursiveRemove (i.e. More...
 
virtual void Info (const char *method, const char *msgfmt,...) const
 Issue info message. More...
 
virtual Bool_t InheritsFrom (const char *classname) const
 Returns kTRUE if object inherits from class "classname". More...
 
virtual Bool_t InheritsFrom (const TClass *cl) const
 Returns kTRUE if object inherits from TClass cl. More...
 
virtual void Inspect () const
 Dump contents of this object in a graphics canvas. More...
 
void InvertBit (UInt_t f)
 
virtual Bool_t IsEqual (const TObject *obj) const
 Default equal comparison (objects are equal if they have the same address in memory). More...
 
virtual Bool_t IsFolder () const
 Returns kTRUE in case object contains browsable objects (like containers or lists of other objects). More...
 
R__ALWAYS_INLINE Bool_t IsOnHeap () const
 
R__ALWAYS_INLINE Bool_t IsZombie () const
 
void MayNotUse (const char *method) const
 Use this method to signal that a method (defined in a base class) may not be called in a derived class (in principle against good design since a child class should not provide less functionality than its parent, however, sometimes it is necessary). More...
 
virtual Bool_t Notify ()
 This method must be overridden to handle object notification. More...
 
void Obsolete (const char *method, const char *asOfVers, const char *removedFromVers) const
 Use this method to declare a method obsolete. More...
 
void operator delete (void *ptr)
 Operator delete. More...
 
void operator delete[] (void *ptr)
 Operator delete []. More...
 
voidoperator new (size_t sz)
 
voidoperator new (size_t sz, void *vp)
 
voidoperator new[] (size_t sz)
 
voidoperator new[] (size_t sz, void *vp)
 
TObjectoperator= (const TObject &rhs)
 TObject assignment operator. More...
 
virtual void Paint (Option_t *option="")
 This method must be overridden if a class wants to paint itself. More...
 
virtual void Pop ()
 Pop on object drawn in a pad to the top of the display list. More...
 
virtual Int_t Read (const char *name)
 Read contents of object with specified name from the current directory. More...
 
virtual void RecursiveRemove (TObject *obj)
 Recursively remove this object from a list. More...
 
void ResetBit (UInt_t f)
 
virtual void SaveAs (const char *filename="", Option_t *option="") const
 Save this object in the file specified by filename. More...
 
virtual void SavePrimitive (std::ostream &out, Option_t *option="")
 Save a primitive as a C++ statement(s) on output stream "out". More...
 
void SetBit (UInt_t f, Bool_t set)
 Set or unset the user status bits as specified in f. More...
 
void SetBit (UInt_t f)
 
virtual void SetDrawOption (Option_t *option="")
 Set drawing option for object. More...
 
virtual void SetUniqueID (UInt_t uid)
 Set the unique object id. More...
 
virtual void SysError (const char *method, const char *msgfmt,...) const
 Issue system error message. More...
 
R__ALWAYS_INLINE Bool_t TestBit (UInt_t f) const
 
Int_t TestBits (UInt_t f) const
 
virtual void UseCurrentStyle ()
 Set current style settings in this object This function is called when either TCanvas::UseCurrentStyle or TROOT::ForceStyle have been invoked. More...
 
virtual void Warning (const char *method, const char *msgfmt,...) const
 Issue warning message. More...
 
virtual Int_t Write (const char *name=0, Int_t option=0, Int_t bufsize=0)
 Write this object to the current directory. More...
 
virtual Int_t Write (const char *name=0, Int_t option=0, Int_t bufsize=0) const
 Write this object to the current directory. More...
 

Static Public Member Functions

static TVirtualMCApplicationInstance ()
 Static access method. More...
 
- Static Public Member Functions inherited from TObject
static Long_t GetDtorOnly ()
 Return destructor only flag. More...
 
static Bool_t GetObjectStat ()
 Get status of object stat flag. More...
 
static void SetDtorOnly (void *obj)
 Set destructor only flag. More...
 
static void SetObjectStat (Bool_t stat)
 Turn on/off tracking of objects in the TObjectTable. More...
 

Protected Attributes

TVirtualMCfMC
 The current transport engine in use. More...
 
TMCManagerfMCManager
 Pointer to requested TMCManager which will only be instantiated by a call to RequestMCManager() More...
 
- Protected Attributes inherited from TNamed
TString fName
 
TString fTitle
 

Static Private Attributes

static TMCThreadLocal TVirtualMCApplicationfgInstance = nullptr
 Singleton instance. More...
 
static Bool_t fLockMultiThreading = kFALSE
 Forbid multithreading mode if multi run via global static flag. More...
 

Additional Inherited Members

- Public Types inherited from TObject
enum  {
  kIsOnHeap = 0x01000000, kNotDeleted = 0x02000000, kZombie = 0x04000000, kInconsistent = 0x08000000,
  kBitMask = 0x00ffffff
}
 
enum  { kSingleKey = BIT(0), kOverwrite = BIT(1), kWriteDelete = BIT(2) }
 
enum  EDeprecatedStatusBits { kObjInCanvas = BIT(3) }
 
enum  EStatusBits {
  kCanDelete = BIT(0), kMustCleanup = BIT(3), kIsReferenced = BIT(4), kHasUUID = BIT(5),
  kCannotPick = BIT(6), kNoContextMenu = BIT(8), kInvalidObject = BIT(13)
}
 
- Protected Member Functions inherited from TObject
virtual void DoError (int level, const char *location, const char *fmt, va_list va) const
 Interface to ErrorHandler (protected). More...
 
void MakeZombie ()
 

#include <TVirtualMCApplication.h>

Inheritance diagram for TVirtualMCApplication:
[legend]

Constructor & Destructor Documentation

◆ TVirtualMCApplication() [1/2]

TVirtualMCApplication::TVirtualMCApplication ( const char *  name,
const char *  title 
)

Standard constructor.

Definition at line 33 of file TVirtualMCApplication.cxx.

◆ TVirtualMCApplication() [2/2]

TVirtualMCApplication::TVirtualMCApplication ( )

Default constructor.

Definition at line 56 of file TVirtualMCApplication.cxx.

◆ ~TVirtualMCApplication()

TVirtualMCApplication::~TVirtualMCApplication ( )
virtual

Destructor.

Definition at line 68 of file TVirtualMCApplication.cxx.

Member Function Documentation

◆ AddIons()

virtual void TVirtualMCApplication::AddIons ( )
inlinevirtual

Add user defined ions (optional)

Definition at line 77 of file TVirtualMCApplication.h.

◆ AddParticles()

virtual void TVirtualMCApplication::AddParticles ( )
inlinevirtual

Add user defined particles (optional)

Definition at line 74 of file TVirtualMCApplication.h.

◆ BeginEvent()

virtual void TVirtualMCApplication::BeginEvent ( )
pure virtual

Define actions at the beginning of the event.

◆ BeginPrimary()

virtual void TVirtualMCApplication::BeginPrimary ( )
pure virtual

Define actions at the beginning of the primary track.

◆ BeginRunOnWorker()

virtual void TVirtualMCApplication::BeginRunOnWorker ( )
inlinevirtual

Define actions at the beginning of the worker run if needed.

Definition at line 135 of file TVirtualMCApplication.h.

◆ BeginWorkerRun()

virtual void TVirtualMCApplication::BeginWorkerRun ( ) const
inlinevirtual

Const Define actions at the beginning of the worker run if needed - now deprecated Use new non-const BeginRunOnWorker() instead.

Definition at line 127 of file TVirtualMCApplication.h.

◆ CloneForWorker()

virtual TVirtualMCApplication* TVirtualMCApplication::CloneForWorker ( ) const
inlinevirtual

Clone MC application on worker.

Definition at line 120 of file TVirtualMCApplication.h.

◆ ConstructGeometry()

virtual void TVirtualMCApplication::ConstructGeometry ( )
pure virtual

Construct user geometry.

◆ ConstructOpGeometry()

virtual void TVirtualMCApplication::ConstructOpGeometry ( )
inlinevirtual

Define parameters for optical processes (optional)

Definition at line 64 of file TVirtualMCApplication.h.

◆ ConstructSensitiveDetectors()

virtual void TVirtualMCApplication::ConstructSensitiveDetectors ( )
inlinevirtual

Define sensitive detectors (optional)

Definition at line 67 of file TVirtualMCApplication.h.

◆ EndOfEvent()

virtual void TVirtualMCApplication::EndOfEvent ( )
inlinevirtual

Define actions at the end of the event before calling SD's end of the event.

Definition at line 101 of file TVirtualMCApplication.h.

◆ Field()

void TVirtualMCApplication::Field ( const Double_t x,
Double_t b 
) const
inlinevirtual

Calculate user field b at point x.

Definition at line 164 of file TVirtualMCApplication.h.

◆ FinishEvent()

virtual void TVirtualMCApplication::FinishEvent ( )
pure virtual

Define actions at the end of the event.

◆ FinishPrimary()

virtual void TVirtualMCApplication::FinishPrimary ( )
pure virtual

Define actions at the end of the primary track.

◆ FinishRunOnWorker()

virtual void TVirtualMCApplication::FinishRunOnWorker ( )
inlinevirtual

Define actions at the end of the worker run if needed.

Definition at line 137 of file TVirtualMCApplication.h.

◆ FinishWorkerRun()

virtual void TVirtualMCApplication::FinishWorkerRun ( ) const
inlinevirtual

Const Define actions at the end of the worker run if needed - now deprecated Use new non-const FinishRunOnWorker() instead.

Definition at line 130 of file TVirtualMCApplication.h.

◆ GeaneStepping()

virtual void TVirtualMCApplication::GeaneStepping ( )
inlinevirtual

Define action at each step for Geane.

Definition at line 116 of file TVirtualMCApplication.h.

◆ GeneratePrimaries()

virtual void TVirtualMCApplication::GeneratePrimaries ( )
pure virtual

Generate primary particles.

◆ GetMC()

TVirtualMC * TVirtualMCApplication::GetMC ( ) const

Return the transport engine registered to this application.

Return the current transport engine in use.

Definition at line 122 of file TVirtualMCApplication.cxx.

◆ InitForWorker()

virtual void TVirtualMCApplication::InitForWorker ( ) const
inlinevirtual

Const Initialize MC application on worker - now deprecated Use new non-const InitOnWorker() instead.

Definition at line 124 of file TVirtualMCApplication.h.

◆ InitGeometry()

virtual void TVirtualMCApplication::InitGeometry ( )
pure virtual

Initialize geometry (Usually used to define sensitive volumes IDs)

◆ InitOnWorker()

virtual void TVirtualMCApplication::InitOnWorker ( )
inlinevirtual

Initialize MC application on worker.

Definition at line 133 of file TVirtualMCApplication.h.

◆ Instance()

TVirtualMCApplication * TVirtualMCApplication::Instance ( )
static

Static access method.

Definition at line 81 of file TVirtualMCApplication.cxx.

◆ Merge()

virtual void TVirtualMCApplication::Merge ( TVirtualMCApplication )
inlinevirtual

Merge the data accumulated on workers to the master if needed.

Definition at line 139 of file TVirtualMCApplication.h.

◆ MisalignGeometry()

virtual Bool_t TVirtualMCApplication::MisalignGeometry ( )
inlinevirtual

Misalign user geometry (optional)

Definition at line 61 of file TVirtualMCApplication.h.

◆ PostTrack()

virtual void TVirtualMCApplication::PostTrack ( )
pure virtual

Define actions at the end of each track.

◆ PreTrack()

virtual void TVirtualMCApplication::PreTrack ( )
pure virtual

Define actions at the beginning of each track.

◆ Register()

void TVirtualMCApplication::Register ( TVirtualMC mc)

Register the an engine.

/// Register the an engine.

Definition at line 104 of file TVirtualMCApplication.cxx.

◆ RequestMCManager()

void TVirtualMCApplication::RequestMCManager ( )

Request a TMCManager which is required if multiple engines should be run.

For backwards compatibility provide a static GetMC method.

Definition at line 91 of file TVirtualMCApplication.cxx.

◆ Stepping()

virtual void TVirtualMCApplication::Stepping ( )
pure virtual

Define action at each step.

◆ TrackingRmax()

virtual Double_t TVirtualMCApplication::TrackingRmax ( ) const
inlinevirtual

Define maximum radius for tracking (optional)

Definition at line 107 of file TVirtualMCApplication.h.

◆ TrackingZmax()

virtual Double_t TVirtualMCApplication::TrackingZmax ( ) const
inlinevirtual

Define maximum z for tracking (optional)

Definition at line 110 of file TVirtualMCApplication.h.

Member Data Documentation

◆ fgInstance

TMCThreadLocal TVirtualMCApplication * TVirtualMCApplication::fgInstance = nullptr
staticprivate

Singleton instance.

Definition at line 154 of file TVirtualMCApplication.h.

◆ fLockMultiThreading

Bool_t TVirtualMCApplication::fLockMultiThreading = kFALSE
staticprivate

Forbid multithreading mode if multi run via global static flag.

Definition at line 159 of file TVirtualMCApplication.h.

◆ fMC

TVirtualMC* TVirtualMCApplication::fMC
protected

The current transport engine in use.

In case of a multi-run the TMCManager will update this whenever the engine changes.

Definition at line 144 of file TVirtualMCApplication.h.

◆ fMCManager

TMCManager* TVirtualMCApplication::fMCManager
protected

Pointer to requested TMCManager which will only be instantiated by a call to RequestMCManager()

Definition at line 148 of file TVirtualMCApplication.h.

Libraries for TVirtualMCApplication:
[legend]

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