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

Used to coordinate one or more TTreeFormula objects.

In particular it makes sure that the dimensions and size of all the formulas is properly coordinated.

Definition at line 30 of file TTreeFormulaManager.h.

Public Member Functions

 TTreeFormulaManager ()
 Tree FormulaManger default constructor.
 
 ~TTreeFormulaManager () override
 Tree FormulaManager default destructor.
 
virtual void Add (TTreeFormula *)
 Add a new formula to the list of formulas managed The manager of the formula will be changed and the old one will be deleted if it is empty.
 
virtual Int_t GetMultiplicity () const
 
virtual Int_t GetNdata (bool forceLoadDim=false)
 Return number of available instances in the formulas.
 
TClassIsA () const override
 
bool Notify () override
 This method must be overridden to handle object notification (the base implementation is no-op).
 
virtual void Remove (TTreeFormula *)
 Remove a formula from this manager.
 
void Streamer (TBuffer &) override
 Stream an object of class TObject.
 
void StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)
 
virtual bool Sync ()
 Synchronize all the formulae.
 
virtual void UpdateFormulaLeaves ()
 This function could be called TTreePlayer::UpdateFormulaLeaves, itself called by TChain::LoadTree when a new Tree is loaded.
 
- 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).
 
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)
 Operator delete [].
 
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 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

virtual void AddVarDims (Int_t virt_dim)
 Add a variable dimension.
 
virtual void CancelDimension (Int_t virt_dim)
 Cancel a dimension.
 
virtual void EnableMultiVarDims ()
 Set the manager as handling a formula with multiple variable dimensions.
 
virtual void UpdateUsedSize (Int_t &virt_dim, Int_t vsize)
 Reload the array sizes.
 
- 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 Member Functions

 TTreeFormulaManager (const TTreeFormulaManager &)=delete
 
TTreeFormulaManageroperator= (const TTreeFormulaManager &)=delete
 

Private Attributes

Int_t fCumulUsedSizes [kMAXFORMDIM+1]
 Accumulated size of lower dimensions as seen for this entry.
 
TArrayIfCumulUsedVarDims
 fCumulUsedSizes(1) for multi variable dimensions case
 
TObjArray fFormulas
 
Int_t fMultiplicity
 Indicator of the variability of the formula.
 
bool fMultiVarDim
 True if one of the variable has 2 variable size dimensions.
 
Int_t fNdata
 ! Last value calculated by GetNdata
 
bool fNeedSync
 
Int_t fUsedSizes [kMAXFORMDIM+1]
 Actual size of the dimensions as seen for this entry.
 
TArrayIfVarDims [kMAXFORMDIM+1]
 List of variable sizes dimensions.
 
Int_t fVirtUsedSizes [kMAXFORMDIM+1]
 Virtual size of lower dimensions as seen for this formula.
 

Friends

class TTreeFormula
 

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 <TTreeFormulaManager.h>

Inheritance diagram for TTreeFormulaManager:
[legend]

Constructor & Destructor Documentation

◆ TTreeFormulaManager() [1/2]

TTreeFormulaManager::TTreeFormulaManager ( const TTreeFormulaManager )
privatedelete

◆ TTreeFormulaManager() [2/2]

TTreeFormulaManager::TTreeFormulaManager ( )

Tree FormulaManger default constructor.

Definition at line 30 of file TTreeFormulaManager.cxx.

◆ ~TTreeFormulaManager()

TTreeFormulaManager::~TTreeFormulaManager ( )
override

Tree FormulaManager default destructor.

Definition at line 49 of file TTreeFormulaManager.cxx.

Member Function Documentation

◆ Add()

void TTreeFormulaManager::Add ( TTreeFormula adding)
virtual

Add a new formula to the list of formulas managed The manager of the formula will be changed and the old one will be deleted if it is empty.

Definition at line 71 of file TTreeFormulaManager.cxx.

◆ AddVarDims()

void TTreeFormulaManager::AddVarDims ( Int_t  virt_dim)
protectedvirtual

Add a variable dimension.

Definition at line 96 of file TTreeFormulaManager.cxx.

◆ CancelDimension()

void TTreeFormulaManager::CancelDimension ( Int_t  virt_dim)
protectedvirtual

Cancel a dimension.

This is usually called when an out-of-bounds index is used.

Definition at line 105 of file TTreeFormulaManager.cxx.

◆ Class()

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

◆ Class_Name()

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

◆ Class_Version()

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

Definition at line 73 of file TTreeFormulaManager.h.

◆ DeclFileName()

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

Definition at line 73 of file TTreeFormulaManager.h.

◆ EnableMultiVarDims()

void TTreeFormulaManager::EnableMultiVarDims ( )
protectedvirtual

Set the manager as handling a formula with multiple variable dimensions.

Definition at line 113 of file TTreeFormulaManager.cxx.

◆ GetMultiplicity()

virtual Int_t TTreeFormulaManager::GetMultiplicity ( ) const
inlinevirtual

Definition at line 66 of file TTreeFormulaManager.h.

◆ GetNdata()

Int_t TTreeFormulaManager::GetNdata ( bool  forceLoadDim = false)
virtual

Return number of available instances in the formulas.

Definition at line 122 of file TTreeFormulaManager.cxx.

◆ IsA()

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

Reimplemented from TObject.

Definition at line 73 of file TTreeFormulaManager.h.

◆ Notify()

bool TTreeFormulaManager::Notify ( )
inlineoverridevirtual

This method must be overridden to handle object notification (the base implementation is no-op).

Different objects in ROOT use the Notify method for different purposes, in coordination with other objects that call this method at the appropriate time.

For example, TLeaf uses it to load class information; TBranchRef to load contents of referenced branches TBranchRef; most notably, based on Notify, TChain implements a callback mechanism to inform interested parties when it switches to a new sub-tree.

Reimplemented from TObject.

Definition at line 68 of file TTreeFormulaManager.h.

◆ operator=()

TTreeFormulaManager & TTreeFormulaManager::operator= ( const TTreeFormulaManager )
privatedelete

◆ Remove()

void TTreeFormulaManager::Remove ( TTreeFormula adding)
virtual

Remove a formula from this manager.

Definition at line 61 of file TTreeFormulaManager.cxx.

◆ Streamer()

void TTreeFormulaManager::Streamer ( TBuffer R__b)
overridevirtual

Stream an object of class TObject.

Reimplemented from TObject.

◆ StreamerNVirtual()

void TTreeFormulaManager::StreamerNVirtual ( TBuffer ClassDef_StreamerNVirtual_b)
inline

Definition at line 73 of file TTreeFormulaManager.h.

◆ Sync()

bool TTreeFormulaManager::Sync ( )
virtual

Synchronize all the formulae.

Definition at line 219 of file TTreeFormulaManager.cxx.

◆ UpdateFormulaLeaves()

void TTreeFormulaManager::UpdateFormulaLeaves ( )
virtual

This function could be called TTreePlayer::UpdateFormulaLeaves, itself called by TChain::LoadTree when a new Tree is loaded.

Because Trees in a TChain may have a different list of leaves, one must update the leaves numbers in the TTreeFormula used by the TreePlayer.

Definition at line 291 of file TTreeFormulaManager.cxx.

◆ UpdateUsedSize()

void TTreeFormulaManager::UpdateUsedSize ( Int_t virt_dim,
Int_t  vsize 
)
protectedvirtual

Reload the array sizes.

Definition at line 308 of file TTreeFormulaManager.cxx.

Friends And Related Symbol Documentation

◆ TTreeFormula

friend class TTreeFormula
friend

Definition at line 47 of file TTreeFormulaManager.h.

Member Data Documentation

◆ fCumulUsedSizes

Int_t TTreeFormulaManager::fCumulUsedSizes[kMAXFORMDIM+1]
private

Accumulated size of lower dimensions as seen for this entry.

Definition at line 38 of file TTreeFormulaManager.h.

◆ fCumulUsedVarDims

TArrayI* TTreeFormulaManager::fCumulUsedVarDims
private

fCumulUsedSizes(1) for multi variable dimensions case

Definition at line 39 of file TTreeFormulaManager.h.

◆ fFormulas

TObjArray TTreeFormulaManager::fFormulas
private

Definition at line 32 of file TTreeFormulaManager.h.

◆ fMultiplicity

Int_t TTreeFormulaManager::fMultiplicity
private

Indicator of the variability of the formula.

Definition at line 33 of file TTreeFormulaManager.h.

◆ fMultiVarDim

bool TTreeFormulaManager::fMultiVarDim
private

True if one of the variable has 2 variable size dimensions.

Definition at line 34 of file TTreeFormulaManager.h.

◆ fNdata

Int_t TTreeFormulaManager::fNdata
private

! Last value calculated by GetNdata

Definition at line 35 of file TTreeFormulaManager.h.

◆ fNeedSync

bool TTreeFormulaManager::fNeedSync
private

Definition at line 45 of file TTreeFormulaManager.h.

◆ fUsedSizes

Int_t TTreeFormulaManager::fUsedSizes[kMAXFORMDIM+1]
private

Actual size of the dimensions as seen for this entry.

Definition at line 41 of file TTreeFormulaManager.h.

◆ fVarDims

TArrayI* TTreeFormulaManager::fVarDims[kMAXFORMDIM+1]
private

List of variable sizes dimensions.

Definition at line 42 of file TTreeFormulaManager.h.

◆ fVirtUsedSizes

Int_t TTreeFormulaManager::fVirtUsedSizes[kMAXFORMDIM+1]
private

Virtual size of lower dimensions as seen for this formula.

Definition at line 43 of file TTreeFormulaManager.h.

Libraries for TTreeFormulaManager:

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