Logo ROOT  
Reference Guide
 
Loading...
Searching...
No Matches
TGeoGlobalMagField Class Reference

Global magnetic field manager.

Provides access to and owns the actual magnetic field set via SetField(). The field is deleted upon destruction of the field manager at the end of ROOT session or by calling:

void SetField(TVirtualMagField *field)
Field setter. Deletes previous field if any. Acts only if fLock=kFALSE.
static TGeoGlobalMagField * Instance()
Returns always a valid static pointer to the field manager.

The previous global field is deleted upon replacement with notification.

The global field manager provides access to the global field via:

One can directly call the Field() method of a field via the global field manager:

void Field(const Double_t *x, Double_t *B)
Double_t x[n]
Definition legend1.C:17

Definition at line 18 of file TGeoGlobalMagField.h.

Public Member Functions

 TGeoGlobalMagField ()
 Global field default constructor.
 
 ~TGeoGlobalMagField () override
 Global field destructor.
 
void Field (const Double_t *x, Double_t *B)
 
TVirtualMagFieldGetField () const
 
TClassIsA () const override
 
Bool_t IsLocked ()
 
void Lock ()
 Locks the global magnetic field if this is set. Cannot be unlocked.
 
void SetField (TVirtualMagField *field)
 Field setter. Deletes previous field if any. Acts only if fLock=kFALSE.
 
void Streamer (TBuffer &) override
 Stream an object of class TObject.
 
void StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)
 
- Public Member Functions inherited from TObject
 TObject ()
 TObject constructor.
 
 TObject (const TObject &object)
 TObject copy ctor.
 
virtual ~TObject ()
 TObject destructor.
 
void AbstractMethod (const char *method) const
 Use this method to implement an "abstract" method that you don't want to leave purely abstract.
 
virtual void AppendPad (Option_t *option="")
 Append graphics object to current pad.
 
virtual void Browse (TBrowser *b)
 Browse object. May be overridden for another default action.
 
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.
 
virtual const char * ClassName () const
 Returns name of class to which the object belongs.
 
virtual void Clear (Option_t *="")
 
virtual TObjectClone (const char *newname="") const
 Make a clone of an object using the Streamer facility.
 
virtual Int_t Compare (const TObject *obj) const
 Compare abstract method.
 
virtual void Copy (TObject &object) const
 Copy this to obj.
 
virtual void Delete (Option_t *option="")
 Delete this object.
 
virtual Int_t DistancetoPrimitive (Int_t px, Int_t py)
 Computes distance from point (px,py) to the object.
 
virtual void Draw (Option_t *option="")
 Default Draw method for all objects.
 
virtual void DrawClass () const
 Draw class inheritance tree of the class to which this object belongs.
 
virtual TObjectDrawClone (Option_t *option="") const
 Draw a clone of this object in the current selected pad with: gROOT->SetSelectedPad(c1).
 
virtual void Dump () const
 Dump contents of object on stdout.
 
virtual void Error (const char *method, const char *msgfmt,...) const
 Issue error message.
 
virtual void Execute (const char *method, const char *params, Int_t *error=nullptr)
 Execute method on this object with the given parameter string, e.g.
 
virtual void Execute (TMethod *method, TObjArray *params, Int_t *error=nullptr)
 Execute method on this object with parameters stored in the TObjArray.
 
virtual void ExecuteEvent (Int_t event, Int_t px, Int_t py)
 Execute action corresponding to an event at (px,py).
 
virtual void Fatal (const char *method, const char *msgfmt,...) const
 Issue fatal error message.
 
virtual TObjectFindObject (const char *name) const
 Must be redefined in derived classes.
 
virtual TObjectFindObject (const TObject *obj) const
 Must be redefined in derived classes.
 
virtual Option_tGetDrawOption () const
 Get option used by the graphics system to draw this object.
 
virtual const char * GetIconName () const
 Returns mime type name of object.
 
virtual const char * GetName () const
 Returns name of object.
 
virtual char * GetObjectInfo (Int_t px, Int_t py) const
 Returns string containing info about the object at position (px,py).
 
virtual Option_tGetOption () const
 
virtual const char * GetTitle () const
 Returns title of object.
 
virtual UInt_t GetUniqueID () const
 Return the unique object id.
 
virtual Bool_t HandleTimer (TTimer *timer)
 Execute action in response of a timer timing out.
 
virtual ULong_t Hash () const
 Return hash value for this object.
 
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.
 
virtual void Info (const char *method, const char *msgfmt,...) const
 Issue info message.
 
virtual Bool_t InheritsFrom (const char *classname) const
 Returns kTRUE if object inherits from class "classname".
 
virtual Bool_t InheritsFrom (const TClass *cl) const
 Returns kTRUE if object inherits from TClass cl.
 
virtual void Inspect () const
 Dump contents of this object in a graphics canvas.
 
void InvertBit (UInt_t f)
 
Bool_t IsDestructed () const
 IsDestructed.
 
virtual Bool_t IsEqual (const TObject *obj) const
 Default equal comparison (objects are equal if they have the same address in memory).
 
virtual Bool_t IsFolder () const
 Returns kTRUE in case object contains browsable objects (like containers or lists of other objects).
 
R__ALWAYS_INLINE Bool_t IsOnHeap () const
 
virtual Bool_t IsSortable () const
 
R__ALWAYS_INLINE Bool_t IsZombie () const
 
virtual void ls (Option_t *option="") const
 The ls function lists the contents of a class on stdout.
 
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).
 
virtual Bool_t Notify ()
 This method must be overridden to handle object notification (the base implementation is no-op).
 
void Obsolete (const char *method, const char *asOfVers, const char *removedFromVers) const
 Use this method to declare a method obsolete.
 
void operator delete (void *ptr)
 Operator delete.
 
void operator delete (void *ptr, void *vp)
 Only called by placement new when throwing an exception.
 
void operator delete[] (void *ptr)
 Operator delete [].
 
void operator delete[] (void *ptr, void *vp)
 Only called by placement new[] when throwing an exception.
 
void * operator new (size_t sz)
 
void * operator new (size_t sz, void *vp)
 
void * operator new[] (size_t sz)
 
void * operator new[] (size_t sz, void *vp)
 
TObjectoperator= (const TObject &rhs)
 TObject assignment operator.
 
virtual void Paint (Option_t *option="")
 This method must be overridden if a class wants to paint itself.
 
virtual void Pop ()
 Pop on object drawn in a pad to the top of the display list.
 
virtual void Print (Option_t *option="") const
 This method must be overridden when a class wants to print itself.
 
virtual Int_t Read (const char *name)
 Read contents of object with specified name from the current directory.
 
virtual void RecursiveRemove (TObject *obj)
 Recursively remove this object from a list.
 
void ResetBit (UInt_t f)
 
virtual void SaveAs (const char *filename="", Option_t *option="") const
 Save this object in the file specified by filename.
 
virtual void SavePrimitive (std::ostream &out, Option_t *option="")
 Save a primitive as a C++ statement(s) on output stream "out".
 
void SetBit (UInt_t f)
 
void SetBit (UInt_t f, Bool_t set)
 Set or unset the user status bits as specified in f.
 
virtual void SetDrawOption (Option_t *option="")
 Set drawing option for object.
 
virtual void SetUniqueID (UInt_t uid)
 Set the unique object id.
 
void StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)
 
virtual void SysError (const char *method, const char *msgfmt,...) const
 Issue system error message.
 
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.
 
virtual void Warning (const char *method, const char *msgfmt,...) const
 Issue warning message.
 
virtual Int_t Write (const char *name=nullptr, Int_t option=0, Int_t bufsize=0)
 Write this object to the current directory.
 
virtual Int_t Write (const char *name=nullptr, Int_t option=0, Int_t bufsize=0) const
 Write this object to the current directory.
 

Static Public Member Functions

static TClassClass ()
 
static const char * Class_Name ()
 
static constexpr Version_t Class_Version ()
 
static const char * DeclFileName ()
 
static TGeoGlobalMagFieldGetInstance ()
 Static getter that does not create the object.
 
static TGeoGlobalMagFieldInstance ()
 Returns always a valid static pointer to the field manager.
 
- Static Public Member Functions inherited from TObject
static TClassClass ()
 
static const char * Class_Name ()
 
static constexpr Version_t Class_Version ()
 
static const char * DeclFileName ()
 
static Longptr_t GetDtorOnly ()
 Return destructor only flag.
 
static Bool_t GetObjectStat ()
 Get status of object stat flag.
 
static void SetDtorOnly (void *obj)
 Set destructor only flag.
 
static void SetObjectStat (Bool_t stat)
 Turn on/off tracking of objects in the TObjectTable.
 

Protected Member Functions

 TGeoGlobalMagField (const TGeoGlobalMagField &)=delete
 
TGeoGlobalMagFieldoperator= (const TGeoGlobalMagField &)=delete
 
void Unlock ()
 
- 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).
 
void MakeZombie ()
 

Private Attributes

TVirtualMagFieldfField {nullptr}
 
Bool_t fLock {kFALSE}
 

Static Private Attributes

static TGeoGlobalMagFieldfgInstance = nullptr
 

Additional Inherited Members

- Public Types inherited from TObject
enum  {
  kIsOnHeap = 0x01000000 , kNotDeleted = 0x02000000 , kZombie = 0x04000000 , kInconsistent = 0x08000000 ,
  kBitMask = 0x00ffffff
}
 
enum  { kSingleKey = (1ULL << ( 0 )) , kOverwrite = (1ULL << ( 1 )) , kWriteDelete = (1ULL << ( 2 )) }
 
enum  EDeprecatedStatusBits { kObjInCanvas = (1ULL << ( 3 )) }
 
enum  EStatusBits {
  kCanDelete = (1ULL << ( 0 )) , kMustCleanup = (1ULL << ( 3 )) , kIsReferenced = (1ULL << ( 4 )) , kHasUUID = (1ULL << ( 5 )) ,
  kCannotPick = (1ULL << ( 6 )) , kNoContextMenu = (1ULL << ( 8 )) , kInvalidObject = (1ULL << ( 13 ))
}
 
- Protected Types inherited from TObject
enum  { kOnlyPrepStep = (1ULL << ( 3 )) }
 

#include <TGeoGlobalMagField.h>

Inheritance diagram for TGeoGlobalMagField:
[legend]

Constructor & Destructor Documentation

◆ TGeoGlobalMagField() [1/2]

TGeoGlobalMagField::TGeoGlobalMagField ( const TGeoGlobalMagField )
protecteddelete

◆ TGeoGlobalMagField() [2/2]

TGeoGlobalMagField::TGeoGlobalMagField ( )

Global field default constructor.

Definition at line 50 of file TGeoGlobalMagField.cxx.

◆ ~TGeoGlobalMagField()

TGeoGlobalMagField::~TGeoGlobalMagField ( )
override

Global field destructor.

Definition at line 72 of file TGeoGlobalMagField.cxx.

Member Function Documentation

◆ Class()

static TClass * TGeoGlobalMagField::Class ( )
static
Returns
TClass describing this class

◆ Class_Name()

static const char * TGeoGlobalMagField::Class_Name ( )
static
Returns
Name of this class

◆ Class_Version()

static constexpr Version_t TGeoGlobalMagField::Class_Version ( )
inlinestaticconstexpr
Returns
Version of this class

Definition at line 50 of file TGeoGlobalMagField.h.

◆ DeclFileName()

static const char * TGeoGlobalMagField::DeclFileName ( )
inlinestatic
Returns
Name of the file containing the class declaration

Definition at line 50 of file TGeoGlobalMagField.h.

◆ Field()

void TGeoGlobalMagField::Field ( const Double_t x,
Double_t B 
)
inline

Definition at line 44 of file TGeoGlobalMagField.h.

◆ GetField()

TVirtualMagField * TGeoGlobalMagField::GetField ( ) const
inline

Definition at line 34 of file TGeoGlobalMagField.h.

◆ GetInstance()

TGeoGlobalMagField * TGeoGlobalMagField::GetInstance ( )
static

Static getter that does not create the object.

Definition at line 110 of file TGeoGlobalMagField.cxx.

◆ Instance()

TGeoGlobalMagField * TGeoGlobalMagField::Instance ( )
static

Returns always a valid static pointer to the field manager.

Definition at line 118 of file TGeoGlobalMagField.cxx.

◆ IsA()

TClass * TGeoGlobalMagField::IsA ( ) const
inlineoverridevirtual
Returns
TClass describing current object

Reimplemented from TObject.

Definition at line 50 of file TGeoGlobalMagField.h.

◆ IsLocked()

Bool_t TGeoGlobalMagField::IsLocked ( )
inline

Definition at line 36 of file TGeoGlobalMagField.h.

◆ Lock()

void TGeoGlobalMagField::Lock ( )

Locks the global magnetic field if this is set. Cannot be unlocked.

Definition at line 128 of file TGeoGlobalMagField.cxx.

◆ operator=()

TGeoGlobalMagField & TGeoGlobalMagField::operator= ( const TGeoGlobalMagField )
protecteddelete

◆ SetField()

void TGeoGlobalMagField::SetField ( TVirtualMagField field)

Field setter. Deletes previous field if any. Acts only if fLock=kFALSE.

Definition at line 86 of file TGeoGlobalMagField.cxx.

◆ Streamer()

void TGeoGlobalMagField::Streamer ( TBuffer R__b)
overridevirtual

Stream an object of class TObject.

Reimplemented from TObject.

◆ StreamerNVirtual()

void TGeoGlobalMagField::StreamerNVirtual ( TBuffer ClassDef_StreamerNVirtual_b)
inline

Definition at line 50 of file TGeoGlobalMagField.h.

◆ Unlock()

void TGeoGlobalMagField::Unlock ( )
inlineprotected

Definition at line 27 of file TGeoGlobalMagField.h.

Member Data Documentation

◆ fField

TVirtualMagField* TGeoGlobalMagField::fField {nullptr}
private

Definition at line 21 of file TGeoGlobalMagField.h.

◆ fgInstance

TGeoGlobalMagField * TGeoGlobalMagField::fgInstance = nullptr
staticprivate

Definition at line 20 of file TGeoGlobalMagField.h.

◆ fLock

Bool_t TGeoGlobalMagField::fLock {kFALSE}
private

Definition at line 22 of file TGeoGlobalMagField.h.

Libraries for TGeoGlobalMagField:

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