Logo ROOT   6.08/07
Reference Guide
List of all members | Public Member Functions | Static Public Member Functions | Static Private Attributes | List of all members
TVirtualMCApplication Class Referenceabstract

Interface to a user Monte Carlo application.

Definition at line 30 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 BeginWorkerRun () const
 Define actions at the beginning of the worker run if needed. 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 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 FinishWorkerRun () const
 Define actions at the end of the worker run if needed. More...
 
virtual void GeaneStepping ()
 Define action at each step for Geane. More...
 
virtual void GeneratePrimaries ()=0
 Generate primary particles. More...
 
virtual void InitForWorker () const
 Initialize MC application on worker. More...
 
virtual void InitGeometry ()=0
 Initialize geometry (Usually used to define sensitive volumes IDs) 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...
 
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 ()
 
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...
 
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 pad. 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...
 
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...
 
Bool_t IsOnHeap () const
 
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...
 
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...
 

Static Private Attributes

static TMCThreadLocal TVirtualMCApplicationfgInstance = 0
 Singleton instance. More...
 

Additional Inherited Members

- Public Types inherited from TObject
enum  { kIsOnHeap = 0x01000000, kNotDeleted = 0x02000000, kZombie = 0x04000000, kBitMask = 0x00ffffff }
 
enum  { kSingleKey = BIT(0), kOverwrite = BIT(1), kWriteDelete = BIT(2) }
 
enum  EStatusBits {
  kCanDelete = BIT(0), kMustCleanup = BIT(3), kObjInCanvas = 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 ()
 
- Protected Attributes inherited from TNamed
TString fName
 
TString fTitle
 

#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 32 of file TVirtualMCApplication.cxx.

◆ TVirtualMCApplication() [2/2]

TVirtualMCApplication::TVirtualMCApplication ( )

Default constructor.

Definition at line 49 of file TVirtualMCApplication.cxx.

◆ ~TVirtualMCApplication()

TVirtualMCApplication::~TVirtualMCApplication ( )
virtual

Destructor.

Definition at line 60 of file TVirtualMCApplication.cxx.

Member Function Documentation

◆ AddIons()

virtual void TVirtualMCApplication::AddIons ( )
inlinevirtual

Add user defined ions (optional)

Definition at line 66 of file TVirtualMCApplication.h.

◆ AddParticles()

virtual void TVirtualMCApplication::AddParticles ( )
inlinevirtual

Add user defined particles (optional)

Definition at line 63 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.

◆ BeginWorkerRun()

virtual void TVirtualMCApplication::BeginWorkerRun ( ) const
inlinevirtual

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

Definition at line 110 of file TVirtualMCApplication.h.

◆ CloneForWorker()

virtual TVirtualMCApplication* TVirtualMCApplication::CloneForWorker ( ) const
inlinevirtual

Clone MC application on worker.

Definition at line 106 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 56 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 127 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.

◆ FinishWorkerRun()

virtual void TVirtualMCApplication::FinishWorkerRun ( ) const
inlinevirtual

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

Definition at line 112 of file TVirtualMCApplication.h.

◆ GeaneStepping()

virtual void TVirtualMCApplication::GeaneStepping ( )
inlinevirtual

Define action at each step for Geane.

Definition at line 102 of file TVirtualMCApplication.h.

◆ GeneratePrimaries()

virtual void TVirtualMCApplication::GeneratePrimaries ( )
pure virtual

Generate primary particles.

◆ InitForWorker()

virtual void TVirtualMCApplication::InitForWorker ( ) const
inlinevirtual

Initialize MC application on worker.

Definition at line 108 of file TVirtualMCApplication.h.

◆ InitGeometry()

virtual void TVirtualMCApplication::InitGeometry ( )
pure virtual

Initialize geometry (Usually used to define sensitive volumes IDs)

◆ Instance()

TVirtualMCApplication * TVirtualMCApplication::Instance ( )
static

Static access method.

Definition at line 70 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 114 of file TVirtualMCApplication.h.

◆ MisalignGeometry()

virtual Bool_t TVirtualMCApplication::MisalignGeometry ( )
inlinevirtual

Misalign user geometry (optional)

Definition at line 53 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.

◆ 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 93 of file TVirtualMCApplication.h.

◆ TrackingZmax()

virtual Double_t TVirtualMCApplication::TrackingZmax ( ) const
inlinevirtual

Define maximum z for tracking (optional)

Definition at line 96 of file TVirtualMCApplication.h.

Member Data Documentation

◆ fgInstance

TMCThreadLocal TVirtualMCApplication * TVirtualMCApplication::fgInstance = 0
staticprivate

Singleton instance.

Definition at line 119 of file TVirtualMCApplication.h.


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